Re: help spec'ing quality (validation/testing) of documentation

Subject: Re: help spec'ing quality (validation/testing) of documentation
From: Elna Tymes <Etymes -at- LTS -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Feb 2002 09:58:04 -0800

julie brodeur wrote:

I work in an environment where I am the "Information Architect" for about
15 system administrators, who have, until recently, written their own
documentation (usage notes in HTML) and posted it to their intranet.

The problem with this is that there was no quality control for testing the
procedures that the sys admins wrote, and no one to follow up on missing

Now I need to recommend a way for a group of people to keep their own
process with quality checks in place, or figure out how to shunt their
info through me (the editor/re-writer) where I would hold it until some
check had been made. <snip>

How about creating an HTML form on the intranet for the sysadmins to use when writing their notes? The form could have radio buttons for the various levels of credibility, and you could add other qualifiers to please the VP. You could also add an automatic notification feature to let you know as soon as something has been added or changed.

Elna Tymes

Los Trancos Systems

Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002.

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.

help spec'ing quality (validation/testing) of documentation: From: julie brodeur

Previous by Author: Re: Netscape 6x
Next by Author: Please help with PDFing tale of woe (long, very long, sorry)
Previous by Thread: help spec'ing quality (validation/testing) of documentation
Next by Thread: RE: What then is the SME/TW functional relationship? (was Re: The ory vs. Practice (was: What's a TW etc...)

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

Sponsored Ads