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:Re: Thoughts on Working With Developers (long) From:Kevin McLauchlan <KMcLauchlan -at- CHRYSALIS-ITS -dot- COM> Date:Tue, 6 Apr 1999 13:37:48 -0400
Jim Burgchardt asked:
I'm curious, how "rough" do most people consider
okay when they're giving an SME a document?
Depends.
Depends on whether the edit happens on my schedule
or on his/hers.
Sometimes I am required to hand off dreck, because I
haven't finished my own work. Usually, that's not because
I originate dreck, but because I often incorporate other
people's text, either nearly-as-is, or simply as a "placeholder"
for when I get around to rewriting that section.
Separate Thought, Related to Thread but not to Question:
Y'know, as valuable as developers are, I find my single
most precious resource are the testers. They write their
own test descriptions late in the game, and then work to
those descriptions. Their docs MUST describe the beast
as it actually works, versus how it was supposed to work,
way back when it was being planned and developed... :-)
Oh... and in case I didn't explicitly say so... I *do* finish
the rewrite and kill the typos before I print for final signoff.