IT Employment

Ask something
Discussion Locked

Network documentation

0 helpful
1 reply

by paradox667

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

Hi all,

Just trying to figure out something:

I'm writing the network doc's for the site I currently work at (finish up here in two days - moving on and up) but I'm not too sure how much 'depth' to go into.

I know from experience that the site will probably not hire someone with relevant skills to manage anything - yet will expect them to be capable.

Should I cover EVERY SINGLE THING...right down to the basics on this network (user creation, maintenance etc)

Or do I just give a broad overview and expect that the site will hire someone with equivelant skills to what I have ? (CNE6, studying CCNA + MCSE)

reason I ask this - is I have given detailed info - that is still fairly broad...but have hit 1000 pages + and still have more to write (along with "how to's" for my replacement)

Thanks for any help / responses :)

1 reply

by black panther

Speak with the Manager and ask them what they require of you. Explain that you can go into more detail if required depending on their requirement. If it's 1000 pages already how easy is it going to be to read for an amateur let alone a qualified IT professional.

When I do documentation I usually stipulate at the beginning of the document the level of expertise required to understand the document and perform the tasks and functions detailed in the document.

hth

This discussion is closed to new replies.