Network Configuration Documentation
Network configuration documentation overview

When troubleshooting a network, a network engineer uses a baseline to efficiently diagnose and correct network problems. The baseline information for a network is captured in documentation such as network configuration tables and topology diagrams. This section discusses the creation of relevant and accurate network documentation as a troubleshooting tool for returning an underperforming, or failing, network back to an acceptable condition. The information contained in this section assumes a worst-case scenario where the network administrator is almost completely unfamiliar with a network and needs to create documentation from scratch.

Useful network documentation will facilitate more effective troubleshooting, thereby saving time and effort. Network documentation will also eliminate the time-consuming and error-prone process of creating a network configuration from scratch.

Network configuration documentation should include elements that provide a logical diagram of the network and detailed information about each component. The troubleshooter should find this information in a single location, either hard copy or on the network at a protected website. At a minimum, network documentation should include the following details:

  • Network configuration tables
  • Network topology diagrams

Note that it is now common practice to compile network documentation on a website.