TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> 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 don't understand how tracing labels from the UI to your manual
_validates_ your operating instructions. All it does is confirm that the
Foobar button is mentioned somewhere in your manual; it tells your QA
dept. nothing about the accuracy, timeliness, clarity, completeness,
etc., of instructions for use of the Foobar button.
IMHO, the proper way for QA to validate operating instructions is to
test them: follow the instructions step-by-step and record the results.
Note any deviations from the expected results, missing steps, etc.
Sounds to me like someone in QA wants to offload part of their work on
you. But this tracing proves nothing of value, and thus is pointless and
stupid. IMHO, of course. :-)
Richard G. Combs
Senior Technical Writer
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
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. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & 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 & Manual: http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-