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:Programmers as writers From:Peterson Karen <Peterson_Karen -at- PRC -dot- COM> Date:Mon, 21 Jun 1999 17:53:49 -0400
Dear Techwhirlers,
Our programmers do a lot of documentation, such as functional design specs.
Because these docs go to our client, they must conform to the clients'
style.
I just spent quite a while peer reviewing a programmer's doc. Some of my
edits dealt with style and mechanics, but there were also a lot of content
issues--the programmer is clearly not trained in writing requirements. I'm
sure it would have taken far less time all around if I had written this doc
myself.
Should we "let" programmers write documentation? Should we just make sure we
get involved as editors? I've had a lot of luck with getting the programmers
to come to me with questions, but I don't think our clients should be
wasting money paying a programmer to write.
I've searched the archives about this without much luck. What are your
experiences/opinions?
