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

Subject: help spec'ing quality (validation/testing) of documentation
From: julie brodeur <jool -at- petting-zoo -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Feb 2002 09:47:15 -0800 (PST)


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. The latter bit ties up the existing documentation so
that no one can use it, so I would obviously like to find some process to
maybe mark the docs on the intranet as PASS/TEST/DRAFT ... or come up with
some similar idea. The VP of our group likes the process that ties up the
documentation, but the users really need access to it ASAP. It's a
catch-22, imo.

I'd be interested to know if anyone else has encountered this type of
problem and how you solved it (if you did). Any other tips or pointers to
related info welcome as well.

Many thanks!

jool -at- petting-zoo -dot- net

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.

Have you looked at the new content on TECHWR-L lately?
See 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 for more resources and info.


Previous by Author: RE: Grim numbers, just grim
Next by Author: RE: I just got one of those resumes
Previous by Thread: "Arbuthnot is no more my friend, who dares to irony pretend..."
Next by Thread: Re: help spec'ing quality (validation/testing) of documentation

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

Sponsored Ads