Network documentation
{{Short description|Technical description of computer networks}}
File:Sample-network-diagram.png]]
Network documentation is a form of technical documentation, the goal of which is to maintain computer networks.{{Cite web|url=http://pluto.ksi.edu/~cyh/cis370/ebook/ch12b.htm|title=Lesson 1: Documenting a Running Network|website=Knowledge Systems Institute|archive-url=https://web.archive.org/web/20161201150027/http://pluto.ksi.edu/~cyh/cis370/ebook/ch12b.htm|archive-date=1 December 2016|url-status=dead}} 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{{Cite web|url=http://packetpushers.net/network-documentation-best-practices-whats-important-how-to-track-it/|title = Network Documentation Best Practices: What's Important & How to Track It - Packet Pushers}}
- 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.{{Cite web|url=http://packetpushers.net/evolution-of-network-documentation/|title=Evolution of Network Documentation - Packet Pushers}}
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,{{Cite web|url=http://graphicalnetworks.com/netterrain-logical-2/|title = Network Documentation Software | DCIM, Network Documentation, OSP Software}} Microsoft Visio,{{Cite web|url=https://support.office.com/en-us/article/create-a-basic-network-diagram-f2020ce6-c20f-4342-84f7-bf4e7488843a|title=Create a basic network diagram - Visio|website=Microsoft|language=en-US|archive-url=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|archive-date=17 April 2018|url-status=live|access-date=17 April 2018}} Docusnap, Gliffy,{{Cite web|url=https://www.gliffy.com/examples/network-diagrams|title=UML Diagram Tool {{!}} How to Make UML Diagrams Online {{!}} Gliffy|website=Gliffy|archive-url=https://web.archive.org/web/20180417101537/https://www.gliffy.com/examples/network-diagrams|archive-date=17 April 2018|url-status=live|access-date=17 April 2018}} Opnet's Netmapper, and XIA Configuration.{{cite web|url=https://www.centrel-solutions.com/xiaconfiguration/|title=XIA Configuration Network Documentation Tool|accessdate=27 September 2017}}