Re: Validating manuals

Subject: Re: Validating manuals
From: Mary Arrotti <mary_arrotti -at- yahoo -dot- com>
To: Michelle Vina-Baltsas <Michelle_Vina-Baltsas -at- datascope -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 12 Apr 2007 07:36:16 -0700 (PDT)

I don't understand the value of validating operating instructions against other documents. Perhaps if you can explain this - you might get some suggestions on how to handle this.

In my experience, when a document is validated or tested it is against the actual UI. And it's not just the UI tags that are looked at - testers also look at whether tasks can be performed by following the instructions. Are the instuctions wrong, incomplete, confusing?

Michelle Vina-Baltsas <Michelle_Vina-Baltsas -at- datascope -dot- com> wrote:
Hello all,

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?

Expecting? Get great news right away with email Auto-Check.
Try the Yahoo! Mail Beta.

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.

Validating manuals: From: Michelle Vina-Baltsas

Previous by Author: Re: Content of a business requirement vs Functional Requirement
Next by Author: Re: Validating manuals - PART II
Previous by Thread: RE: Validating manuals
Next by Thread: RE: Validating manuals

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

Sponsored Ads