Home arrow Practices arrow Page 6 - Writing A Software Technical Reference Manual (part 2)

Sealed With A Kiss - Practices

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
With all of this behind you, you will finally be ready to release themanual. The following frills will complete the package:

1. Cover page
  • The name of the software should be written in accordance with thebrand decided.
  • The version number of the software should be clearly stated.
  • The name of the developer with address and contact numbers.


2. Table of contents
  • The topics should be linked to the matter inside.


  • 3. Notifications for proprietorship and confidentiality

    4. Headers and footers
  • Headers could include the project name and version number of thedocument.
  • Footers can have the page numbers and a short confidentialitynotice.


  • It might also be a good idea to include a feedback form as the lastpage, as your users will probably get back to you with suggestions. Thiswill be especially useful if there is a second phase of development forthe software.

    And that's about it. Publish your manual (either on paper or as anelectronic PDF) to your customer, and relax - you've earned it!

    Note: Examples are illustrative only, and are not meant for a productionenvironment. Melonfire provides no warranties or support for the sourcecode described in this article. YMMV!

     
     
    >>> 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: