RE: Style guides - doc standards vs processes

Subject: RE: Style guides - doc standards vs processes
From: Erika Yanovich <ERIKA_y -at- Rad -dot- co -dot- il>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 6 Nov 2001 09:54:45 +0200

ISO and all the other arguments are all OK, but let's go back to Lucinda's
original question:

<I'm curious -- how many of you include a "documentation roadmap" as part of
your style guides? How many of you have written up any type of roadmap at
all? In my department, we created two guides.>

Yes, we do have 2 guides, but we view the style guide as an appendix to the
process guide.
Yes, it is time consuming to write them, but:
1. To determine whether one should write them or not, I recommend Chapter 3
of JoANN T. Hackos's book: Managing Your Documentation Projects
2. It is much more time consuming to maintain them (therefore one should
seriously consider this before starting -- an outdated procedure/guide may
be worse than a non-existing one)

Erika

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

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

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


Previous by Author: Help without manuals
Next by Author: RE: Software simulation
Previous by Thread: RE: Style guides - doc standards vs. processes
Next by Thread: RE: Style guides - doc standards vs processes


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


Sponsored Ads