Contains a conceptual description of what is implemented, what
functionality it provides and how it works. May contain drawings that
support the explanation.
A listing of the installed software components and their respective
versions that comprise the over all solution. It should also contain the
instructions on how to verify each component’s version and how/where to
Describes any solution specific hardware components that are critical to
the functionality. This is not a description of your entire network but
rather a short depiction of specific needs.
These outline the step-by-step instructions on how to get from the
shrink-wrapped software CD to the usable application on the server or
workstation. There may be sub-chapters in this section for each software
component listed in the “Software Components” chapter.
This section should explicitly talk about the process of adjusting the
“out-of-the-box” software and hardware components to the specific
functional environment in your company. It should give example for
specific configuration data but not specify the actual data to be entered.
A little tricky but very helpful when it contains information on the most
common problems and how to diagnose or resolve them. Typically you want to
maintain this section frequently as you discover new issues and their
Notice that this is separated from the “Configuration Procedures”
section. The reason for this is that the configurations may change very
frequently and will typically be computer and/or user specific. Think
about this section as sets of data that fill in the blanks in the
This is a “catch all” section for further documentation needed to
either better understand the solution or in some other way support the
chapters above. Here you should mention or establish relations to
documents for which the content doesn’t need to be recreated in the