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