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.
RE: Documentation plans, standards manuals, and more
Subject:RE: Documentation plans, standards manuals, and more From:rick -dot- henkel -at- channelpoint -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 3 Apr 2001 09:10:27 -0600
At my previous position, I was one of five editors for a team of 40 writers
(before layoffs). The department goal was to write our documentation (70
manuals of about 500 pages each) so the reader would think one writer did
all of them. With those guidelines, we needed a pretty strict set of
standards (including word usage, naming conventions, etc.) for our writers
to follow. So I can understand where she's coming from.
> I would like to develop a documentation standards guide to address
> usage, style, naming conventions, templates and more; to be used by the
doc
> team, development, and possibly other teams. I would also like to develop
a
> formal documentation plan for the new product we are developing.
Are you going to tie the writers down to their desks and beat them with
sticks
as well?
:-) I'm just being silly. But I have a serious question to ask...
Do you really need all these things? What is hindering you right now from
writing documents such that you need all this stuff?
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
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.
