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.
I have a question regarding troubleshooting sections in user guides
. . . if, in each chapter, there is a troubleshooting section, where should
it be located? Should the troubleshooting section (in Q & A form) be at the
end of each chapter, or should there be an appendix at the end of the
document that would contain all of the troubleshooting Q & As?
Also, is it correct to have "troubleshooting" in the TOC? For
example:
