Discussion Locked

Computer and Network documentation

0 helpful
7 replies
Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.

I have been in my position for several years with two different companies. In each business, I inheirited an un-documented network, and with no logs, no records, no documentation on any of the servers, switches / hubs, software, and operating systems. It has always been a hassle to play 'catch-up' while attempting to maintain the existing network structure. I have read the article in TR about "You've just inherited an undocumented network: Now what? - Nov 7, 2001" But there were no suggested methods or manner to document your work.

I have sought to develop a method to 'start' the record keeping process in each business, but I always wonder what ideas that other techs / administrators use for their documentation process. So, I am asking other professionals to share their method, means, and manner which they use. Here are some questions I might ask.

1. How many people are in your IT staff?
2. How many servers do you administer?
3. How many sites are you responsible for?
4. What OS's are you using, and why?
5. How do you document daily log?
6. What documentation is used for hardware / software changes?
7. Why have you selected this style / manner of documentaion?
8. What problems have you experienced in your documentation procedure?
9. What tips or hints could you offer to others?
10. Where are your records kept? Are they handy to other staff?
11. How is your documentation communicated to other staff?
12. If you could change the way your records and documentation is kept, what would they be? And why?
13. What is your network topology and how do you record any changes or repairs?

I only offer these questions as a starting point. Each network will be totally different, each company will have varied requirements, and each IT shop will not be the same as others. In any case, can you share what you do in your organization to document your different network components?

7 replies

by road-dog

Network documentation should be kept up with every add, move or change, and the person who designs or implements the change should have the responsibility and the tools to do so. Disciplined policies and procedures will be different for different sized networks, but the common denominator is that the documentation procedure should not be so cumbersome that nobody complies with it. For enterprise networks, I advise my customers to procure Visio for all network personnel, and have them print a copy of the network drawing before the change, and redline changes on the copy. The redlined copy is forwarded to a draftsman or the Engineer doing schematics full time or on a rotating basis.

When the network is documented, then keeping the documentation up to date is a task requiring all person's participation, so it must be added to the personnel evaluation structure, affecting bonuses & raises.

As documentation is accumulated, It can be made readily accessible via internal web page. When this is done well, it is a wonder to behold.

I am kind of a zealot on this issue. If anyone is interested send me an email and I'll park some samples on my FTP page for download.

by jerrykidd

Please e-mail me the link to get those samples!

I like your idea of setting up an internal web site with that info...I'll bet it's easier to maintain as well as easier to use.

mailto:jerry@jerrykidd.com

TIA

Jerry Kidd

by gokovav

Can anyone send my email=gokovav@yahoo.com,network documentation demos tutorials programs etc...
And please if anyone maked a network documentation project can help me because i am a computer enginner student at class 4 and i am in under training in a firm and they want me to document their network.They said that they want add remove update the system on the documentation.I need help if anyone who has experience or ideas please help me on this forum or mail me i am waiting .Thanks from now
gokovav@yahoo.com

by road-dog

Things that should be documented:
LAN:
-Schematics, all distribution devices, their port connections and addresses.
-Important devices; servers, power users, atypical users, VIPs.
-All router and switch configurations, blades, serial numbers, revisions of code.
-Spare copies of the standard images used on the network for all classes of devices.

WAN:
-Schematics, all distribution devices, their port connections and addresses.
-Circuit information, including provider circuit number, speed, and DLCI, major line configuration (B8ZS/AMI, SF/ESF).
-INTER LATA handoffs.
-POC with contact number of circuit provider, escalation procedure, status of open/ closed/archived trouble tickets.
-POC, phone number, and address of all remote sites (important for drop-ship of spare parts)
-Back door modem numbers for out of band management.
-Emergency plan for disaster recovery, including circuit remap.
-Spare copies of the standard images used on the network for all classes of devices.
-Boilerplate design for typical remote site for uniformity and checklist for activation.

by tbragsda

The bane of every network admins? life. We all want good documentation, but hate to create it.

- When installing a new system, service etc. Document during the install
o What this thing does.
o What are its dependencies (circuits, other servers etc).
o What are its backup/recovery procedures.
o How does it fit into the network, where must it exist, and why.
- NDS (if you don?t have Netware servers, for get this)
o NDS can virtually document its self. Monthly I dump NDS info into a text file, and have written several parsing routines to cull useful data.
- People/process
o Don?t forget the all-important users in your documentation. Do some documentation from the business unit perspective. This counts for DR, growth planning etc.
- DRP/BCP (By far should be the largest binder on the shelf.)
o What are the critical systems/functions
? What equipment hosts this function.
? What other equipment is necessary to allow this function.
? Who/how many use this.
? Steps to recovery.

The DRP could take a day to list. Most documentation really should be geared towards DR. If I kick the bucket, and someone walks in to my network, I would expect them to pick-up the DRP.

by calikader

Are NDS and DRP synonyms of some services or programs that automaticly document about network?

This discussion is closed to new replies.