Content

| 1.3 |  | Building-Block Approach |
| 1.3.5 |  | Creating end-system network configuration documentation |

Good end-system network configuration documentation allows rapid discovery of specific information about end-systems.

Guidelines for creating effective end-system network configuration documentation are:

- Know which end systems are part of the domain to determine the scope of the end-system network documentation.
- 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.
- Use consistent terminology, abbreviations, and style.
- Try to make the documents orderly and easy to understand.
- Use templates and keep a library of symbols and graphic icons.
- Store the network documentation in a location where it is readily available on the job. A copy of the documentation should be kept in a secure location off-site.
- Maintain the documentation!
- Modify the network documentation as conditions and devices in the network change.

A process should be implemented for handling changes to the network documentation. Factors in this process that need to be accounted for are reporting network changes, maintaining version control, and assigning responsibility for modifying and distributing updated documents.

Example
A network technician’s primary job function may be to maintain and troubleshoot network servers and desktops. The team already does a respectable job of fixing problems but has been asked to create documentation of the network end-systems to expedite troubleshooting efforts and cut down on costs. The company currently has configuration tables and topology diagrams of the network configuration without end-systems.

A month later, the network support staff has been using the end-system documentation for troubleshooting. Estimates have determined that the time that the department spends troubleshooting end-systems in the past month has dropped considerably. The documentation was a success for the following reasons:

- The scope of the documentation was determined accurately because of familiarity with the end-systems on the network.
- The appropriate types and amounts of information for each documented end-system were recorded.
- Standardized symbols and terminology consistent with the existing network documentation were used.
- Documentation was kept current by implementing a system for employees to report changes and by updating the documentation in a timely manner.
- The documentation was stored in convenient and clearly marked locations close to each administrative terminal.

| Lab Activity Lab Exercise: End-System Baseline discovery In this lab, the student will establish the baseline for the configuration and operation of the end-systems in the student network.