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:Troubleshooting From:Elizabeth Huth <elizabeth_huth -at- GILBARCO -dot- COM> Date:Mon, 23 Oct 1995 08:01:49 EST
I'm working on a hardware service manual that will include a Troubleshooting
section. I am interested to learn how others organize this section. I will be
listing the information in a table format with the headings similar to
"Problem," "Cause," and "Actions to take."
My question is how would be the best way to list the problems. Alphabetize them?
List by major section? For example a car might have problem sections for engine,
fuel system, etc.