 | | | |
Technical writers need to decide what information is to go into a manual, and in how much detail. Such decisions can have a crucial effect on manual quality. Poor decisions can result in published manuals that lack required information, contain unsuitable or unnecessary information, or repeat information in other manuals. To help make better decisions, Hitachi technical writers use Manual Quality Tables. The tables specify what type of information is to go into a manual, the required level of detail, and sources for the information. These tables enable writers to itemize the required contents of a manual before starting to write the manual. In addition,
during later revisions, the tables enable writers or
reviewers to easily discover any topics that were left out
in the original version.
View all 2240 works published by STC Proceedings |
Using Manual Quality Tables To Improve Manual Quality
http://www.stc.org/ConfProceed/2003/PDFs/STC50-091.pdf
Sudo, Hideki
STC Proceedings
2003
Abstract: Technical writers need to decide what information is to go into a manual, and in how much detail. Such decisions can have a crucial effect on manual quality. Poor decisions can result in published manuals that lack required information, contain unsuitable or unnecessary information, or repeat information in other manuals. To help make better decisions, Hitachi technical writers use Manual Quality Tables. The tables specify what type of information is to go into a manual, the required level of detail, and sources for the information. These tables enable writers to itemize the required contents of a manual before starting to write the manual. In addition,
during later revisions, the tables enable writers or
reviewers to easily discover any topics that were left out
in the original version.
|
|
| |
There are 12 readers currently online: 0 registered users and 12 guests. Register.