HomePractices Writing A Software Technical Reference Manual (part 2)
Writing A Software Technical Reference Manual (part 2)
With the groundwork out of the way, this concluding partexamines the standard components of a technical reference manual,explaining what goes into each section and why. It also discusses theprocess by which such a manual should be reviewed and vetted prior todelivery to a customer.
In the first part of this article, I discussed the purpose and goals ofa software technical reference manual, explaining who the targetaudience usually is and how to cater to its needs. I also talked alittle bit about how to go about deciding the scope of things to becovered in your manual, and discussed the standard components of astylesheet for such a manual.
In this second article, I'll build on what you've learned thus far byputting together a sample table of contents for this type of manual, anddiscussing how to break the technical material up into a format that isboth structured and easily understandable. Keep reading!