RE: Issues about documentation process/management

Subject: RE: Issues about documentation process/management
From: "Erika Yanovich" <ERIKA_y -at- rad -dot- com>
To: "SB" <sylvia -dot- braunstein -at- gmail -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 15 Jun 2008 11:41:20 +0300

I want to comment just on the quality issue when during lack of
resources, I saw this in several postings (embedded in other issues). I
believe there is basic quality that comes from the process and the
writer's training and external quality that comes from reviews/edits.
There should be no compromise on the basic quality, just on the external

Let's say your process defines that each manual should comply with a
standard outline and style guide. The writer also knows the importance
of consistency and acts accordingly. These are 'rules' the writers
adhere to during work (even during rush time). So most manuals will come
with a basic quality I believe is essential. On the other hand, because
there is not enough time, the editor will not review the manual. This is
the external quality that may not be there for a certain release.

1. In order to trade quality for time, you must first define what do you
mean by quality and try to not give up on some.
2. Real life situations are usually more complex than the 'time =
quality' equation.


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Issues about documentation process/management: From: SB

Previous by Author: Re: MS Word: Syntax for getting into a page footer to swap out graphic?
Next by Author: Excel-like functionality in PDF
Previous by Thread: Re: Issues about documentation process/management
Next by Thread: Re: Issues about documentation process/management

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

Sponsored Ads