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.
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. 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-
