TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I have found this set of descriptions and suggestions helpful over the
years, and so have colleagues, employers, and head-hunters with whom I
work.
Hope you too find it helpful.
Rivka Arieli
Senior Technical Writer, Editor, Instructional Designer
in Vancouver, BC
Beginning Technical Writer
Has a background in English or Journalism, preferably, but not
necessarily with a
university degree. Has professional non-fiction writing experience. May
or may
not have some training in technical writing, but is willing to take
training.
Is able to prove with samples and references:
* an excellent command of English,
* learns fast and easily,
* a sense of humour,
* able to write in a variety of styles,
* able to organize information in different ways for different purposes,
* pays careful attention to detail,
* able to manage time well, establish and maintain priorities, and meet
deadlines,
* able to interview others and hear accurately,
* able to accept criticism and comment and use it constructively,
* able to work well with all kinds of people in differing circumstances,
often
under stress.
Junior Technical Writer
Has all attributes of the Beginning Technical Writer.
Has limited eperience working with subject-matter experts, editors,
other writers,
printers, artists, designers and others. May or may not have some
courses in
technical writing.
Writes draft material to existing plans and designs. Re-organizes and
rewrites
materials written by others.
May be able to do limited copy editing and proofreading.
Knows how to use at least one sophisticated word-processing program and
can
work on a PC.
Experienced Technical Writer
Has all attributes of the less-experienced levels of technical writing.
Is trained, experienced, and good at the following and can prove it
through a
portfolio and several references.
Document planning.
Writing.
Interviewing.
Researching.
Rewriting.
Has some experience working with subject-matter experts, editors, other
writers,
printers, artists, designers and others.
Capable of copy editing, proofreading, and may be able to perform
substantive
and other editing.
Knows how to use at least one sophisticated word-processing program and
can
work on a PC. Has some experience with several other sophisticated word-
processing and desktop publishing programs and with a variety of
hardware.
Senior Technical Writer
Has all attributes of the other levels of technical writing.
Is trained, experienced, and good at the following and can prove it
through a large
portfolio and a variety of references.
Planning and managing documentation projects.
Producing and meeting budgets, schedules, objectives, milestones.
Employing, supervising and managing staff: writers, editors, artists,
printers, etc.
Excellent organizational skills.
Editing.
Writing.
Interviewing.
Researching.
Rewriting.
Has extensive experience working with subject-matter experts, editors,
other
writers, printers, artists, designers and others.
Has broad experience with several sophisticated word-processing and
desktop
publishing programs and with a variety of hardware.
What A Writer Should Ask Him/Herself
What type of writing do I enjoy most, and do I do well?
Have I ever completely planned a document or document set for a product
or
service?
Have I completed writing such a document or set?
Have I ever hired or contracted staff? Were they happy and productive as
required?
Has my employer been happy with the results of my work?
Have I worked with: engineers, programmers, managers, end-users,
technicians,
the general public, subject-matter experts? How often? How much? What
were
the results?
How much money do I want to make?
What are my actual expenses?
For what types of product do I want to write? For what types do I not
want to
write?
What kind of writing and/or editing do I not want to do?
What do I need to learn?
How well am I taking criticism?
Do I hear what is really being said to me?
When did I last take a course that was connected with my work?
Into which of the levels of technical writing do I fit?
Who are my references and will they support me? Have I asked them for
support
for my current application(s)?
Is my portfolio up to date and appropriate for this application?
Is my resume appropriately written for this application?
Have I overstated anything in my resume?
What an Employer Should Ask Him/Herself
How assertive does the writer need to be?
How much experience does the writer need to complete this job?
How fast does this writer learn?
What type of personality will best fit this job and fit with other
staff?
When must the document(s) be published? distributed?
Can this writer meet the required deadlines?
What resources can and should I provide to the writer:
* equipment
* furniture
* references
* services
* assistance.
Testing and
Portfolio
To check the abilities of the candidate, a test can be given. It should
be given
under supervision with a time limit. A proven senior technical writer
can provide
such a test.
Test and/or look
for:
* Organization of information for different purposes and different
audiences.
* Appropriate vocabulary for different audiences.
* Appropriate use of active and passive voice.
* Brevity and clarity of writing.
* Useful repetition and redundancy.
* Parallel construction.
* Ability to use graphics (pictures, charts, graphs) to replace words.
* Reasons for not using graphics.
What an Employer Should Ask References
Would you employ this person again as a Technical Writer? Why? Why not?
At what level do you think this person should be employed?
What did the person do for you? planning, writing, editing, rewriting,
designing,
budgeting, scheduling, hiring, interviewing, research, etc.
What are the main strengths of this person?
What are the weaknesses?
What things need further training?
How well does the writer take criticism? instruction?
Considerations for the Employer and the Candidate
People who are good at one style or type of technical writing may not be
good at
another.
People who are good writers may not be good editors, and vice versa.
People who can write and/or edit cannot necessarily manage, and vice
versa.
People who are subject-matter experts and who write may not be good
technical
writers.
People who are good technical writers/editors do not need to be
subject-matter
experts. They have the ability to learn fast and translate other
peoples' words and
writing into appropriate materials.
Be sure samples are written by the candidate.
Check with at least two references.
Agree to an initial trial period and mutual assessment at its end.
Produce clear and concrete goals, objectives, schedule, milestones,
deliverables.
Avoid ambiguity and vagueness.
Suggested
References
People who have been employed by the candidate.
People who have employed the candidate.
Colleagues.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.