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: Format for receiving document reviews From:Linda Castellani <linda -at- GRIC -dot- COM> Date:Tue, 23 Jun 1998 11:28:24 -0500
For help files, I have my clients use the compiled .hlp file and use the
annotation feature. When a topic is annotated, a little green paperclip is
added to the beginning of the topic. To prevent needing to go through the
help file topic by topic searching for green paper clips, my clients add a
bookmark for each topic for which there is an annotation.
The help file can go from reviewer to reviewer and ultimately to me, with
annotations and bookmarks visible as long as the compiled .hlp and the .ann
are kept together in the same directory. One of the advantages to this is
that the annotation viewer has a copy function that can be used to print
the comments out. When using this method, it is important to remember that
the .ann file can only be viewed with the compiled .hlp file that was used
to make the annotations. In other words, if you make changes and
recompile, the new .hlp file won't work with the previous .ann file.
At 09:12 AM 6/23/98 +1000, Jean Weber wrote:
>
>You could do the same with RTFs from help projects, though it would be a
>bit messier (because of the difficultly the reviewer may have in working
>out what topic is which -- especially the popups). Ship the reviewer a
>compiled help file to review, and the RTF to mark up in Word.
>
>> For example, for help files, we don't want anyone mucking around with our
>.RTF files
>