Discussion Locked

Need Advice On Network Documentation

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

About a year and half ago, the management committee at my company outsourced our IT needs to a consulting firm. They in turn placed an individual in our office to be our system admin and then proceeded to redesign and improve our network environment. Last week, I reviewed the first draft of our consultant’s network documentation. I was very disappointed with the lack of information and detail provided. There was no inventory of hardware and the software inventory was a partial list that only displayed the software title and # of licenses. The network diagrams/layouts were very basic, just pictures of computers/printers/servers with arrows our hub and arrows to our ISP. Some of the IT policies where included and others where mentioned by name only.
I know a few things that need to be documented in greater detail, but this isn't my area of expertise.
Can anyone give me advice on what information should be documented and in what detail?

10 replies

by madwoodsman

I would check out http://www.ecora.com

Basically, when it comes to network documentation...it should be detailed enough that you could recreate your environment if your building disappeared tomorrow. Reality is that it is not often that detailedor if it is then it is not up to date. That is where a product like ecora can be a big help.

At minimum, your documentation should be complete enough that a replacement system admin could walk in...pick up your network doc and be ready to work.
- Gordon

by the watcher

I was looking for something like that as i have taken over a network that... shall we say lacks? documentation and needs to bring it up to speed

Thanks

The Watcher

by road-dog

You're problem is not needing a software package, its with the consultants. If a firm accepts a PO and invoices for services rendered, then they bloody well should be trained and equipped to do the work.

I would verify the level of detail asked for in your negotiation with the consultants, and if it is not met, tell them so.

As is, if ANY software tool is good to do the job with, then they should procure it. If not, why pay them? You could buy the tool and run it yourself if it is so automatic and thorough in function.

Methinks you got jammed....

by singhdba

I know we did. My company hired me to be the DBA of their new database serveral months after they hired these consultants. I'm the only tech person in the company, everyone else is in finance. Since I can't get rid of these guys until their contractexpires(another 1 1/2 years), I've made it part of my job to make sure we get the most out of them.

by road-dog

I've made megabucks documenting networks.

It just torques me when "professionals" go into a customer site and do not leave documentation. I turn over a schematic and other documentation elements on every network I do.

by Member 25088450

Think of it as what would we need to keep going if everything was distroyed in an earthquake (can you tell I am from California). Inventory everything. Get a CD camera and take pictures of the network equipment. List computers by Make/Model and purchase date. List all software loaded on server and computers. keep back-ups off site and have a plan on how you will recover.

We have held disaster drills several times to test all departments readyness. I must supply my records directly to the disaster warden when the "emergency" hits.

Don't wait until something happens before you act.

by singhdba

Apparently we already have a disater recovery SOP and documentation. I've never actually seen this. It was only shown to Management. But seeing the Network docs, I bet these docs are incomplete as well. I'll request a copy of those as well.

by tmcclure

If they are responsible for disaster recovery, check to see if there are any test requirements and the rsults of any tests.

by sharad sreedharan

I would recommend to have a look at establishing an IT Policies & Procedures framework, where in you would be able to be very clear with the consultants on what you may require.

You may refer to the 'IT Policies and Procedures' documentation by GEE Publishing (need to pay), it's quite useful and provides general guidelines in details (although a bit UK specific, it can be adopted). Here is the address of the company

GEE Publishing Ltd
100 Avenue Road
Swiss Cottage
London
NW3 3PG

Web:http://www.gee.co.uk
Customer Services Tel: 020-7393 7666/7

Also the Site Security Handbook (RFC 2196) provides much in details on security, because that's the priority for today's networks.

This discussion is closed to new replies.