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.
Subject:RE: Indexing: how to test an index From:"Skilton Katherine (ism1kns)" <KSkilton -at- ismd -dot- ups -dot- com> To:"TECHWR-L (E-mail)" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 18 Jan 2000 14:16:17 -0500
I always found it useful to have someone unfamiliar with the product go
through the manual. Give them a highlighter and tell them to highlight the
words/topics they don't know or understand. That's a good quick check. That
will also help if you're doing a glossary. This gets you the basics. Then,
if you have testers, I'd give them the index and have them try to use it. In
theory, they should have test cases or user cases, and have an idea what
should be there.
Sr. Methods Analyst
United Parcel Service
From: Melissa Kucbel-Saumier [mailto:melissaks -at- eicon -dot- com]
Sent: Tuesday, January 18, 2000 2:01 PM
Subject: Indexing: how to test an index
I was asked to index one of our manuals (the source files are in
FrameMaker) and I find it quite hard to test the result against
the final document. I am used to testing instructions against an
application, but what are the things to look out for when testing
an index built from scratch?