Writing a Software Technical Reference Manual (part 1) - A Little Knowledge... (
Page 3 of 5 )
Any developer attempting this document should ensure that (s)he has:
- A sound understanding of how the project is structured
- Complete knowledge of the control flow within and between all
components
- Complete knowledge of all the APIs in the application
- Knowledge of the data structures and the storage containers used
- Knowledge of the variables used in all the components
- An understanding of how the installation files are packaged
- An understanding of how the user interface has been developed
- Knowledge of the variables that need to be configured to initialize
the application
- Sufficient knowledge of the software platform on which the application
has been developed.
While the requirements specification and design documents usually
contain this information too, an understanding of the reasons why, say,
a particular API has a certain boundary value, or a certain variable is
a configuration variable and not a runtime variable, would be invaluable
to someone explaining their utility.
Assuming adequate knowledge on the part of the developer/writer, the
next step is to assess the scope of the material covered by the STRM.
Let's look at that next.
/ 11 
