Documentation plans, standards manuals, and more

Subject: Documentation plans, standards manuals, and more
From: Jessica Pease <JPEASE -at- Partnerware -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 30 Mar 2001 12:17:49 -0600

Hello everyone,

I'm new to the list and have searched the archives but didn't find the
results I need.

I've done tech writing for web sites and university mainframe software. 90%
on-line help or training documentation with 10% development and system
requirements documentation. I've either worked on teams that had yet to
develop standards, or as the lone writer who had her own, relatively
informal standards.

I am now working with more complex software and a team of writers and
trainers. 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.

Does anyone have any examples of a standards guide or documentation plan
that they can share with me?



*** 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 or info -at- devahelp -dot- com

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.

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 for more resources and info.

Previous by Author: Multiple versions of a document
Next by Author: RE: Dreamweaver to create HTML Help?
Previous by Thread: Re:
Next by Thread: Re: Documentation plans, standards manuals, and more

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

Sponsored Ads