Network documentation explained

Network documentation is a form of technical documentation, the goal of which is to maintain computer networks.^[1] It contains information about how the network is built, how it should perform, and where to troubleshoot problems. The purpose of network documentation is to keep networks running as smoothly as possible while minimizing downtime when repairs are necessary.

Parts

Essential parts of network documentation include:

• Map of the entire network, including hardware locations for servers and network equipment and cabling details^[2]
• Metadata on the individual servers
• Schedules and locations of backups
• Metadata on installed software, including version numbers, installation dates, licensing details, and support information
• Vendor and contractor information
• Service agreements
• Detailed record of problems, solutions, procedures, and results

Network documentations could contain charts, tables, diagrams, and even memory aids that help administrators locate information faster.^[3]

Documentation tools

Though network documentation can be done by hand, large organizations must use network documentation software, including diagramming tools, inventory management, and circuit and cable traces. Examples include draw.io, Graphical Networks' netTerrain,^[4] Microsoft Visio,^[5] Docusnap, Gliffy,^[6] Opnet's Netmapper, and XIA Configuration.^[7]

Notes and References

1. Web site: Lesson 1: Documenting a Running Network. Knowledge Systems Institute. https://web.archive.org/web/20161201150027/http://pluto.ksi.edu/~cyh/cis370/ebook/ch12b.htm. 1 December 2016. dead.
2. Web site: Network Documentation Best Practices: What's Important & How to Track It - Packet Pushers.
3. Web site: Evolution of Network Documentation - Packet Pushers.
4. Web site: Network Documentation Software | DCIM, Network Documentation, OSP Software.
5. Web site: Create a basic network diagram - Visio. Microsoft. en-US. https://web.archive.org/web/20180417083745/https://support.office.com/en-us/article/create-a-basic-network-diagram-f2020ce6-c20f-4342-84f7-bf4e7488843a?ocmsassetID=HA102748912&CorrelationId=cdbe611d-4331-43f1-90fe-ec3acd71a0f6&ui=en-US&rs=en-US&ad=US. 17 April 2018. live. 17 April 2018.
6. Web site: UML Diagram Tool How to Make UML Diagrams Online Gliffy. Gliffy. https://web.archive.org/web/20180417101537/https://www.gliffy.com/examples/network-diagrams. 17 April 2018. live. 17 April 2018.
7. Web site: XIA Configuration Network Documentation Tool. 27 September 2017.