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.
Subject:Rewriting versus writing from scratch? From:"Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 29 Nov 2000 09:21:20 -0500
Stina Lane-Cummings manages <<... a seven-person documentation team. We're
at a crossroads where we can make a decision about who writes white
papers... There are two thoughts: Subject Matter Experts (SMEs) should
write, and the docs team should polish the SMEs' work. I don't like this
idea because of what happened during our test case... Even the best writing
done by SMEs takes so much time to untangle and rewrite that the writers
should write from scratch, using the SMEs as clients/consultants, because
it's faster for both parties and easier for the SMEs.>>
If your second option is objective fact, or as close as we poor mortals can
get to it, and your test case proved that an SME who writes reasonably well
still can't write good white papers, then it sounds like you don't have a
choice: your writers should do the writing, using the SMEs as consultants.
This fits my prejudice that it's hard to write well about something you're
really close to, particularly if you're not a writer to begin with. But a
sample size of one test case isn't very compelling to me, and my experience
is that SMEs are easier to train than most of us think.
<<What kinds of hybrid scenarios make sense?>>
The most obvious one is to get your writer and the SME to work together to
develop a comprehensive outline, since the SME should be better than the
writer at knowing what's important. (That's why they're called "experts".
<g>) The next option to consider is that some of your SMEs can undoubtedly
be trained to write decent first drafts, perhaps in point form to save time,
and this resource may be helpful when you're busy with other work. This
requires a good knowledge of the skills of the SMEs plus willingness to work
with them to figure out how you can share the work and minimize everyone's
workload.
"Quebits took the art of manual writing to such extremes [that] the first
human scholars who'd tried to decipher their written language had spent a
lifetime working through what they hoped would be a definitive piece of
Quebit culture. No one was quite ready to say it wasn't, but the huge
ancient text had proved to be a manual for installing a sewage system within
a city."--Julie Czerneda, "Changing Vision"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
Publications Management Clinic, TECH*COMM 2001 Conference, and more http://www.SolutionsEvents.com or 800-448-4230
---
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.