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: Reviewing online help From:"Richard Pineger." <Richard_Pineger -at- PAC -dot- CO -dot- UK> Date:Tue, 9 Dec 1997 09:38:30 +0000
Geoff Hart wrote:
> I'm not sure what the problem is here. If you've chunked
> your text properly, each topic should have a heading and as
> many subheads as are necessary to sub-chunk the information
> effectively. If that's the case, page numbers should be
Thank you Geoff,
The help system (and program that it describes) has been around
for about 7 years now and I do not have opportunity to restructure it. Your
fundamental assumption that it would be 'chunked' properly does not
The technique I have decided to try is to supply a paginated
hard copy with page numbers, an index (containing topic headings) and a
table of contents. I used help2doc.exe to generate a word file and wrote a
macro to generate the index from the topic titles.
I will also supply the help system to the programmers and arrange
review meetings covering approx 50 pages of the hard copy per meeting. The
50 pages are based around a consecutive list of topics in the table of
contents. The reviewer can either read on-screen then use the index to find
the topic for marking, or, use the printed table of contents followed by
the index to find the topics. Whichever they decide they will have me sat
next to them doing the same while they do it. The links and context IDs
will be tested separately. Indeed, the context IDs have already been