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.
Elizabeth Huth asked about organizing the troubleshooting section in a
hardware manual. The replies I read indicated that most people believe
the audience is the primary factor in determining how the section should be
developed. I agree completely and have an additional suggestion.
Place a short blurb at the beginning of the section explaining your
rationale and your thoughts on how the section should be used. If the
audience is clued into how you were thinking when you structured the
section, it may make it easier for them to find what they need.
Hope this helps.
Tony Pieri
TSCOM012 -at- DUNX1 -dot- OCS -dot- DREXEL -dot- EDU
