Documentation Standards Guide

Subject: Documentation Standards Guide
From: Kathleen Frost <kfrost -at- BTSQUARED -dot- COM>
Date: Tue, 23 Sep 1997 10:13:15 -0400

I am looking for doc standards outlines.

I am in the process of setting up a Documentation Standards Manual for my
company. I am the only technical writer at present (doing all online, user
doc, training, prog. reference, release notes, etc. for 4 major products
and 4 support products). Our company writes interactive sales software
with remote to HQS data sychronization for sales people in the field. The
applications are complex enough without having vague writing standards.

We have 22 employees right now, but will be up to 40 people by the end of
'97 and up to 80 by the end of '98. By then, I'll have six to eight people
in my documentation department and will be covering marketing material as
well as user documentation, internal programming, and the various
specification documents. I want to write up everything I can think of to
be sure there are procedures and policies in place when the new people
start arriving. Since I have pressing deadlines for a major release, I
need all the help and suggestions I can get.

Does anyone have an outline for a documentation standards manual that they
would be willing to share? I need as many categories as I can find to be
sure everything is covered.

Please contact me off line, as I am on digest, or fax me a copy, if it's
allowed at your work place.

Thanks in advance.


Kathleen Frost, Publications Specialist
BT Squared Technologies, Inc.
2790 Clairmont Road, Suite 1010
Atlanta, GA 30329 (USA)

KFrost -at- BTSquared -dot- com
Ph: 404-321-1010 ext. 11
Fax: 404-321-0072

Interactive Sales Software with product configurators, quotes and order
applications, marketing encyclopedia, and automated proposal generation.
Visit our web site: www.btsquared.com

We will start accepting resumes for full time technical writers with
RoboHELP and either Windows 95, Windows NT or Word 97 experience in October
1997.

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Additon to John's Upgrade to Word 97 Summary
Next by Author: Re: documenting Unix command lines; more than one line
Previous by Thread: Re: *Best* On-line Military...
Next by Thread: Software Tools


What this post helpful? Share it with friends and colleagues:


Sponsored Ads