Making Documentation Less Painful

IMPORTANT: If you are stumbling across this, you should read this blog post first.

This is a simple demo of how I use git and draw.io for documentation. Typically I have a README.md page in the root of the Repo that just describes the purpose of a documentation repository. For a small organization, one repository with sub-folders for each system/group of systems will do the trick. If you are in a very large organization it might make sense to have separate repositories for the various IT functions so that you can control access / organize things better.

Network Documentation

For documentation on network devices, please use the Network folder.

Systems and Network Monitoring Documentation

For documentation on monitoring infrastructure please use the [Monitoring](/Systems and Network Monitoring/) folder.

Systems Documentation

For documentation on server systems please use the Systems folder.