Re: Style guides - doc standards vs processes

Subject: Re: Style guides - doc standards vs processes
From: Andrew Plato <intrepid_es -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 5 Nov 2001 09:15:05 -0800 (PST)

"Metzger, Lucinda" wrote...

> The style manual covers things like:
> -Document layout
> -Agreed-upon terminology
> -Capitalization standards
> -Product acronyms
> -Trademark information
>
> The procedures manual covers the actual processes, like:
> -How doc projects are initiated
> -How to pull a product sample from stock
> -How to peer edit another writer's doc
> -What form to use when sending a doc to review
> -How to submit a drawing change to our drafting group
> -How to post a doc to our website
> -How to archive the files at the end of the project

Is there any time left for doing your job? While all of these things are
nice to have written down, this is secondary, one-off work. This type of
stuff should be developed in down-times.

And yes, you should be able to write documentation without a formal style
guide and documentation plan. The best style guides emerge naturally out
of writers doing the documentation and making decisions about the material
as it is being written.

Andrew Plato

__________________________________________________
Do You Yahoo!?
Find a job, post your resume.
http://careers.yahoo.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author! iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers. Join our almost
10,000 published authors today. http://www.iuniverse.com/media/techwr

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
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.



Follow-Ups:

Previous by Author: Re: More Unions
Next by Author: Re: Style guides - doc standards vs processes
Previous by Thread: RE: Style guides - doc standards vs processes (WAS: bad leadership an d tech writing)
Next by Thread: RE: Style guides - doc standards vs processes


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


Sponsored Ads