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: Developer Documentation From:John Gilger <jgilger_it -at- NV -dot- DOE -dot- GOV> Date:Tue, 23 Mar 1999 08:27:09 -0800
I have to agree with Jane on this one. I don't recall having the choice
of what I wrote. If the boss wants a doc written or edited, that is
what I get paid to do.
I am amazed at the attitude of some tech writers that they only write
user manuals.
Variety is the spice of life. It is a lot more interesting to have a
part in design, documentation, marketing, and whatever else needs to be
written. Heck, I've even edited/rewritten letters for the CEO.
I guess that I am more of a wordsmith that likes to work with words than
a technical writing specialist.
John
-----Original Message-----
From: Jane Bergen [SMTP:jbergen1 -at- EARTHLINK -dot- NET]
Sent: Tuesday, March 23, 1999 8:11 AM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Re: Developer Documentation
Scott Wahl writes:
>I would recommend against volunteering to write and format
developer
docs.
<snip>
Whoaaaaa. Not all technical writers write only customer
documentation.
While I wouldn't recommend that tech writers WRITE the developer
docs,
I do think it's a good idea to volunteer to edit them. And edit
for
content, organization, and style as well as for grammar and
spelling.
This could have several benefits, but primarily the ones below:
