Writing a network manual....?

Hey,

I was just wondering how you guys set out your network manuals? I've given myself the task of writing out a manual/reference to how our network is laid out, set up, what's currently going on and how to do something like checking proxy logs or unblocking a website in case I leave.

Everytime I start writing it I decide that it's not laid out properly and give up and now I've decided I must do it :p So, any pointers? Perhaps someone could post up an example or one of their manuals?

Many thanks :)

Maybe a wiki

Start with a network diagram - topographical.

Each data cabinet becomes a 'node' -> detail each node on a seperate page.

This is something that's on my to-do list!

Over the last two years I've managed to document everything, but it's all in separate documents, I'd really like to combine it all into one big one (even if it's just an abridged version).

I started by laying out a table of contents... but didn't get a lot further:


- Network
o Physical cabling
o Cabinet locations
o Network hardware
o Wireless system

- Server Infrastructure
o Physical servers
o Virtual environment
o Storage servers

- Services:
o Domain Services
 DHCP
 DNS
o Backups
o Messaging
o Printing
o MIS
 SIMS.net
 SLG2
o VLE
o System Deployment and Imaging: FOG
o UPS
o CCTV
o Disk Quotas

- Client Machines
o Desktops
o Laptops
o Macintosh Clients

- Software

- Departmental Procedures

I tried to do this a few months ago. Like everyone else, I stopped because it got boring!!

take a a look here

Network Documentation - Home

In the downloads section there is a template that I started to use. You might have to tweak it to get it relevant to your network but its a good start.

Use a wiki combined with a Visio repository for actual diagrams. Export visio diagrams as flat images to illustrate wiki pages.

We use Dokuwiki, partly because it's ridiculously easy to use in a DR situation (flat text files), other people have their own favourites.

We also use a WIKI but have neglected it for some time and have not updated it - these summer holidays are going to manic for me with the amount of work on, so i'm hoping to plan a quiet October half term and get everything fully documented then.