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: WinHelp test plans From:Tim Altom <taltom -at- IQUEST -dot- NET> Date:Tue, 21 Nov 1995 08:48:00 EST
>First I produce a dummy help system. Every topic contains nothing more than
> its ID. Using this file the programmers can test their help calls and I can
> figure out which ID is accessed where.
>During developement I add all IDs as search keywords. Some authoring tools
> (e.g. the shareware program Visual Help) offer that possibility.
Would that we could do these things! Sadly, we're always called in when the
links are already there and the client is slavering for words. If we're
lucky, the developers will get a look at the help file for critique. Full
testing is a dream.
>Another important topic is a clear, simple structure of your help system.
> "Author lost in hyperspace" is much more serious than "User lost in
> hyperspace".
Bravo! I wish more of our clients would realize this.
>Finally, you cannot help but test all links as thoroughly as possible -
> especially when writing context-sensitive help.
>Greetings from Germany,
>Alexander
Tim Altom
Vice President
Simply Written, Inc.
Technical Documentation and Training
Voice 317.899.5882
Fax 317.899.5987