Sysadmin

5628 readers

1 users here now

A community dedicated to the profession of IT Systems Administration

founded 5 years ago

MODERATORS

[email protected]

DarraignTheSane

Advice for building documentation for a small company? (self.sysadmin)

submitted 2 years ago by kurosawaa to c/[email protected]

11 comments fedilink hide all child comments

Hi guys, I recently started working at a company with about 50 people that has grown to large for their current IT setup. They have no documentation or any SOPs. Has anyone been in a similar situation and how did you go about creating documentation, especially when you are new and don't fully understand all of the services they have in place?

Thankfully it's mostly a Microsoft shop and pretty low tech but there are dozens of exchange rules in place that no one knows why they exist or what they do, dozens of SharePoint sites with critical information strewn about them and so on. It's hard to think where to even start and decide what the best way to organize this information will be, and keep in a place a system where we will update it regularly. Any advice would be greatly appreciated.

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 2 points 2 years ago* (last edited 2 years ago)

I'm partial to infrastructure as code techniques as a way of writing things down and tracking changes, but that's obviously not always possible in corporate IT with "edge computing".

If you're documenting something related to code or a specific computer, I think readme .md files are the best, because you can't lose them.

If you're writing pure documentation, there are really nice markdown site generators like docusaurus, but if you're just making internal documentation, you can just file everything with an online cloud documentation tool like Notion or even Google Docs. If you want online documents like Google docs, but you don't want Google to have all your secrets, you can run your own corporate Nextcloud server, which is very common in Europe.