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.
The postings in response to Michele's request for advice all contain sound
suggestions. Geoff Hart is absolutely right. Don't throw the writer at the
SME. The result will likely be misery for all three of you. Rowena Hart's
work plan suggestion is excellent given your short time frame. I would only
add that you might want to begin by outlining the basic documentation
process and then proceed with two or three short exercises.
EXPLAIN:
1. Plan
2. Obtain information (interview the SME, review the existing application
etc.)
3. Compose a first draft. This stage often includes follow-up questions for
the SME. Encourage your intern to keep a running issues list and then to
contact the SME once each day or two or three times each week.
4. Submit and revise as often as necessary.
EXERCISES:
Develop some simple documentation exercises: How to buy groceries, how to
drive a stick shift, how to tie your shoelaces. These exercises may sound
hokey but I have found them effective when training someone new to
documentation because the subject matter is familiar. This familiarity
reduces anxiety in new writers.
