Good network configuration documentation allows rapid discovery of specific
information about network devices.
Guidelines for creating effective network documentation are:

- Determine the scope: Know which end systems are part of the domain to
determine the scope of the end-system network documentation
- Know your objective: Only collect data that is relevant to the objective
and provide sufficient detail for those relative pieces. Extra layers of
information will only make the documentation more difficult to use.
- Be consistent: Use consistent terminology, abbreviations, and style. Use
templates and keep a library of symbols and graphic icons that can be reused.
- Keep the documents accessible: Store the network documentation in a
location where it is readily available on the job. A copy of the documentation
should also be kept in a secure off-site location.
- Maintain the documentation: Modify the network documentation as conditions
and devices in the network change.
A standardized process should be implemented for handling changes to
network documentation. Factors in this process that need to be accounted for
include reporting network changes, maintaining version control and assigning
responsibility for modifying and distributing updated documents.
Example
Last year documentation of the network for a branch of
the corporation was completed. One year later, troubleshooters still use the
network documentation to successfully troubleshoot network problems. The
following is a list of reasons that the documentation process was successful:
- Network segments and devices were identified within the domain of
responsibility.
- The purpose for creating the documentation was determined.
- The most experienced network employees were queried to learn about what
information would be the most useful to meet their needs.
- Consistent symbols and terminology were used to represent the data in both
graphical and tabular form.
- Logical locations were designated to store copies of the documentation and
indexing permitted networking personnel to easily find the needed data. A
sign-out sheet was implemented so that possession of copies of the network
documentation could be accounted for.
- A reporting system was instituted so employees could relay information
about changing conditions in the network to a central location. When a change
in network conditions took place, employees knew whom to notify and that person
promptly modified, dated, and distributed the updated documentation to the
designated locations.