How to properly maintain IT infrastructure documentation?

Question

Documentation

Good afternoon!
I wondered how to maintain documentation of the IT infrastructure of an enterprise. There were thoughts about the wiki, but can you tell me something more correct?
And how do you keep the documentation to the system administrator?
Thanks in advance

Answer 1

I would think something like this when compiling the documentation.
There is a new employee in a vacuum. They should be able to figure out the bulk of the hardware/software configuration data that they might have questions about without contacting you.
I may be wrong, but it seems to me that this is the main goal.

Answer 2

usually this is all a normally built monitoring system plus documentation for specific servers / services / equipment + network / dependency map (often in a monitoring system)

Answer 3

That's right - so that documentation helps to solve typical and emergency issues and takes a minimum of time and nerves. Good documentation will look different for every organization. There are a lot of materials (at a glance: 1 , 2 , 3 , 4 ), look, read, choose what is relevant to you. Well, try not to produce documents with similar data, if after transferring the server from one rack to another you need to change three xls files, make changes to the wiki in five places and fix four diagrams in the visio, then the likelihood is that in a few years in these documents there will be a lot of different information.
A wiki is a very good tool for general documentation, especially if you have multiple administrators, but a single wiki is not enough.

Answer 4

If you don’t want to invent anything and you’re not too lazy to mess around a lot, make the executive documentation complete once (yes, a regular guest doc file), and then just update it)

Answer 5

i use racktables for hardware and detailed hardware specs and some big primitive excel files

Answer 6

Вики или markdown в репозитории. На вики по моему опыту все забивают. Чтобы не забивали можно проверить наличие документации при pool request. Но лучше генерировать автоматически инструментами типа Javadoc, DSL-ями какими-то (тут от задачи зависит) и тд.

Answer 7

Чем дольше живу, тем чаще склоняюсь к мысли, что настроенная по всем стандартам система не требует документации. Как у программистов: хороший код - сам себе и есть документ.

Answer 8

Посмотри glpi - вполне адекватная ИС для IT-инфраструктуры