Network documentation

[mattjones]

Hi,

 

I am interested to know how schools/trusts store their network documentation. Is anyone using IT Glue or similar?

 

Thanks,

Matt

[CHiLL]

We just have a shared OneNote document, splitting the documentation up in different pages and tabs. The information within OneNote is searchable and you can include attachments (though they aren't searchable).

[simpsonj]

OneNote here, easy to share and password protect sensitive data.

[Chaniel]

We currently use OneNote synced via Teams and it works fine for our purposes, sections for different areas (e.g. Contacts, Networking, Printing, Processes etc.). It's quite nice now that it's done via Teams so I can access it at home/on my mobile if necessary. I'd recommend using something like Wiki.js (https://js.wiki/) for wiki-like documentation.

I find the biggest thing with documentation is that it's not so much what you use, but that you actually use it and update it... oh and that it's searchable.

[jthompson]

Fairly basic here still, using free tools: DokuWiki for general info and instructions; KeePass password manager; Racktables for what's patched into where in the network cabs; diagrams and maps created with Dia, Graphviz and QGIS.

[dmj]

If you are talking about "Network" in the literal sense rather than general IT configuration, then I find the best method is to dump the configs of the switches/routers into a private git repository.

config dumps makes equipment replacement much easier as it is fairly straightforward to convert configs from model to model and any Network engineer would be able to read the configs as the best source of documentation. You can even throw in some diagrams to keep management happy. It's also the hands down best method for recovering from corrupt configs.

Git is particularly well suited to this kind of task because it holds revision histories and makes it simple to see who has made changes and when.

[Jaan]

We use Google here.

 

So we use Google apps and have a "Tech Central" (Google Sites) where all our systems and documentation is accessible. by the "IT admin" members.

 

we also have links from "Tech Central" to a It admin team/shared drive for things like switch configs etc

[TechMonkey]

OneNote with links to our IT Department document store (in Sharepoint)

Anything sensitive is kept in our Password Manager

[Danp]

We use Google here.

 

So we use Google apps and have a "Tech Central" (Google Sites) where all our systems and documentation is accessible. by the "IT admin" members.

 

we also have links from "Tech Central" to a It admin team/shared drive for things like switch configs etc

 

I think I'm going to do this. I'm a team of one with no documentation when I started. There's only so much info I can keep in my head plus I want to have something I can share with the deputy head (knowing she won't do anything with the info) so they are not left in the lurch if I'm not around.

[ThatBoringBloke]

You mean I have to write about it as well as keep it running!?

[jthompson]

You mean I have to write about it as well as keep it running!?

 

Yep. And then write about it all over again about every 18 months.

[Liam]

We use sharepoint through our staff team. Works well. Not really searchable but everything it laid out well.

 

Im intrigued to see people's network diagrams, backup procedure documentation etc...

 

Love a bit of documentation..

[TwistedHelixis]

Mainly Google docs or Sheets. I also keep a paper record of the important stuff in the school safe.

 

Was thinking of using Google Keep, which although not as good as One Note is similar (ish)

[jthompson]

I find that the features of a wiki are really helpful, as you can speedily add, edit and link things but keep everything structured, versioned and searchable with minimal extra effort. All of the mark-up features for things like code snippets, TOC's, footnotes, strike-out, etc. are also great for documentation and allow you to go into lots of technical detail without pages feeling overloaded.