Home arrow Practices arrow 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.

TABLE OF CONTENTS:
  1. Writing A Software Technical Reference Manual (part 2)
  2. Starting Off Easy
  3. System Shock
  4. Remote Control
  5. Improving Yourself
  6. Sealed With A Kiss
By: Deepa L, (c) Melonfire
Rating: starstarstarstarstar / 3
February 13, 2003

print this article
SEARCH DEV SHED

TOOLS YOU CAN USE

advertisement
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!

 
 
>>> More Practices Articles          >>> More By Deepa L, (c) Melonfire
 

blog comments powered by Disqus
escort Bursa Bursa escort Antalya eskort
   

PRACTICES ARTICLES

- Calculating Development Project Costs
- More Techniques for Finding Things
- Finding Things
- Finishing the System`s Outlines
- The System in So Many Words
- Basic Data Types and Calculations
- What`s the Address? Pointers
- Design with ArgoUML
- Pragmatic Guidelines: Diagrams That Work
- Five-Step UML: OOAD for Short Attention Span...
- Five-Step UML: OOAD for Short Attention Span...
- Introducing UML: Object-Oriented Analysis an...
- Class and Object Diagrams
- Class Relationships
- Classes

Developer Shed Affiliates

 


Dev Shed Tutorial Topics: