RE: Validating manuals

Subject: RE: Validating manuals
From: stevefjong -at- comcast -dot- net
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 12 Apr 2007 14:20:24 +0000

Michelle Vina-Baltsas wrote:
> > My company QA department wants to begin validating our
> > operating instructions against the software user interface
> > (UI) documents . I use FrameMaker 7.0 (unstructured) to
> > create the manual and am using conditional text to manually
> > trace the UI tags to the specific sentences/passages in the
> > FrameMaker file. This is very time consuming and tedious.
> > Does anyone have to do this type of tracing to a UI or to
> > another document type? If so, how are you doing it?

I think what you are describing is essentially a very thorough index. That does have value, of course, but I also think that rather than verifying that every UI feature is mentioned in the documentation, a much better use of QA's time for all concerned would be to validate that the statements in the documentation, and especially the procedures, are correct.

-- Steve

Steven Jong ("Typo? What tpyo?")
Past President, STC Boston Chapter
stevefjong -at- comcast -dot- net, 978-413-2553 [C]
* I am a candidate for STC Director | For more info, visit: *

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.

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual:

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.


Previous by Author: RE: no QA
Next by Author: Re: Problem Co-worker
Previous by Thread: Re: Validating manuals
Next by Thread: Validating manuals - PART II

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

Sponsored Ads