How to Create a Network Documentation
Ask for help., Work out the format., Think what information you need to collect in that documentation; suggestions could be: number of physical locations (where your company works), how those locations are connected (wireless, wired), number of...
Step-by-Step Guide
-
Step 1: Ask for help.
Common sense will tell that if you are a new employee and you need to understand how the network works you can ask for a documentation from your new colleagues.
If you don't find such a documentation maybe you are lucky to find a colleague that wants to give you details.
You can have the surprise to find people that don't want to share information with the rest of the team: sad situation but real. -
Step 2: Work out the format.
If you want to create yourself a network documentation from scratch you probably understand the necessity and usability.
You need to establish the format in which you will store the documentation and other aspects such as people who will work and access and update it. , You must understand how your network works in order to establish what information you will need to help you when trouble arise. , If you want something simple, you can download a network documentation software from the internet and you need to make sure that you have the proper access to install the software and to access the servers and subnets on the network.
After you will run the software you will gain a drawing which will have a scheme of servers, computers and other network devices connected.
Key words for this step could be: proper rights and permissions to install / run this network documentation software. , If you work in a network with many servers and other network devices you can use this software, but if you have a simpler and smaller network it's good to create some schemes yourself. , That's necessary because let's say a server is down and you don't know the reason for that and one reason could be that after applying some updates (for example) something goes not quite well.
You can also have hardware failures (other example) and of course one can find a list of other reasons for that. , If you have a good network diagram you can prove compliance with policies, security standard and that will help not only you but by proving compliance with policies your managers will be much more confident in the IT department. -
Step 3: Think what information you need to collect in that documentation; suggestions could be: number of physical locations (where your company works)
-
Step 4: how those locations are connected (wireless
-
Step 5: wired)
-
Step 6: number of routers
-
Step 7: switches
-
Step 8: firewalls
-
Step 9: servers in each location (with passwords
-
Step 10: types of operating systems
-
Step 11: update management
-
Step 12: types of hardware
-
Step 13: types of RAID
-
Step 14: period of guarantee offered by vendors for hardware and software
-
Step 15: rules in firewall)
-
Step 16: a contact list with people responsible with administration
-
Step 17: help desk
-
Step 18: a contact list with companies that offers support for hardware and software
-
Step 19: documented and tested procedures for disaster / recovery scenarios
-
Step 20: places to store backups (on site and off site)
-
Step 21: procedures for trial restores.
-
Step 22: Make it as simple or as complex as you need.
-
Step 23: Analyze that drawing and see if you are satisfied with the details for each device.
-
Step 24: Have a picture of how devices are connected
-
Step 25: but also know exactly how to reach physically each device.
-
Step 26: Improve compliance.
Detailed Guide
Common sense will tell that if you are a new employee and you need to understand how the network works you can ask for a documentation from your new colleagues.
If you don't find such a documentation maybe you are lucky to find a colleague that wants to give you details.
You can have the surprise to find people that don't want to share information with the rest of the team: sad situation but real.
If you want to create yourself a network documentation from scratch you probably understand the necessity and usability.
You need to establish the format in which you will store the documentation and other aspects such as people who will work and access and update it. , You must understand how your network works in order to establish what information you will need to help you when trouble arise. , If you want something simple, you can download a network documentation software from the internet and you need to make sure that you have the proper access to install the software and to access the servers and subnets on the network.
After you will run the software you will gain a drawing which will have a scheme of servers, computers and other network devices connected.
Key words for this step could be: proper rights and permissions to install / run this network documentation software. , If you work in a network with many servers and other network devices you can use this software, but if you have a simpler and smaller network it's good to create some schemes yourself. , That's necessary because let's say a server is down and you don't know the reason for that and one reason could be that after applying some updates (for example) something goes not quite well.
You can also have hardware failures (other example) and of course one can find a list of other reasons for that. , If you have a good network diagram you can prove compliance with policies, security standard and that will help not only you but by proving compliance with policies your managers will be much more confident in the IT department.
About the Author
Claire Simmons
Creates helpful guides on pet care to inspire and educate readers.
Rate This Guide
How helpful was this guide? Click to rate: