Documentation folders

Started by Dieselboy, June 07, 2017, 05:29:01 AM

Previous topic - Next topic

Dieselboy

In my old network role back in UK we had a central location for literally everything including documentation. The was the intranet (sharepoint). I remember we had a folder structure, templated. So when a brand new customer came onboard either greenfield or brownfield, the intranet would immediately be updated (manually) with an empty folder structure.

I'm trying to remember this folder structure so I can do something similar at my place. I can't remember at all.

What's typically important for customers documentation? Here's what I can remember. Can anyone suggest anything further?


Customer name
1.       Projects
a.       In-progress
b.      Completed
2.       Documentation
a.       Server
b.      Network
3.       HR
4.       Something-else

deanwebb

High level design document/diagram
Low level design documents / diagrams
Work instructions
Standard Operating Procedures

Bill of Materials
Purchase orders
Statements of work
Take a baseball bat and trash all the routers, shout out "IT'S A NETWORK PROBLEM NOW, SUCKERS!" and then peel out of the parking lot in your Ferrari.
"The world could perish if people only worked on things that were easy to handle." -- Vladimir Savchenko
Вопросы есть? Вопросов нет! | BCEB: Belkin Certified Expert Baffler | "Plan B is Plan A with an element of panic." -- John Clarke
Accounting is architecture, remember that!
Air gaps are high-latency Internet connections.

Otanx

Points of Contacts - technical (server and network), after hours contact procedures. Escalation procedures for when you can't get ahold of POC. This should be phone, email, mailing, and physical addresses.

-Otanx

Dieselboy

Thanks guys! Plenty that I forgot there! Site contacts ->> one of the most important ones!

SimonV

#4
If you have a standardized hostname system, you can have one folder per device with a physical diagram, pictures, inventory details, etc.
For sites, the IP Plan, WAN documentation, license files, original design documents...

deanwebb

Quote from: SimonV on June 09, 2017, 06:07:53 AM
If you have a standardized hostname system, you can have one folder per device with a physical diagram, pictures, inventory details, etc.
For sites, the IP Plan, WAN documentation, license files, original design documents...


That reminds me... add the "Device Naming Convention" document to my list, above. :smug:
Take a baseball bat and trash all the routers, shout out "IT'S A NETWORK PROBLEM NOW, SUCKERS!" and then peel out of the parking lot in your Ferrari.
"The world could perish if people only worked on things that were easy to handle." -- Vladimir Savchenko
Вопросы есть? Вопросов нет! | BCEB: Belkin Certified Expert Baffler | "Plan B is Plan A with an element of panic." -- John Clarke
Accounting is architecture, remember that!
Air gaps are high-latency Internet connections.