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:Word setup for manual From:"E,T, Hull" <ethull -at- WORLDACCESS -dot- NL> Date:Sun, 18 May 1997 13:59:52 +0200
Hello to all,
I will soon begin writing a technical manual of about 120 pages. This is
the first time I have done this using Word 7. I would like to get some
tips from those of you who have experience with this kind of thing. In
particular how should I set up Word to keep track of:
* section and page numbering for the table of contents
* key words with page numbers for the index
* key words with page numbers for a list of Definitions of terms
* figures with page numbers for a list of figures
Some of you talk about a "master document". What does it include and is it
handy for this kind of manual? The manual will be organized as follows:
PART ONE - TO THE OPERATOR
* General introduction
* Climate and process control. (Here we give the operator insight into the
* General description of the equipment
* Operating instructions.
* Trouble shooting
* 20 most often asked questions
* error messages explained
* what to do if ...
* preventive maintenance schedule (weekly, monthly, yearly etc.)
* Manufacturer support
* Help desk
* Contact numbers and addresses for dealers etc.
* Definitions of terms
PART TWO - TO THE INSTALLER
* Introduction to the Installation guide
* Drawing/photo of the unit showing
* all other items mentioned in the text
* What needs to be installed; list in order of installation. For each
* Where is it
* How to install it
* Circuit diagrams
* List of replaceable and critical parts