Как правильно вести документацию IT инфраструктуры?

Добрый день!

Задался вопросом, как вести документацию IT инфраструктуры предприятия. Были мысли о wiki, но может подскажите что-то более правильное?
И как вообще вести документацию сисадмину?

Заранее спасибо
  • Вопрос задан
  • 8804 просмотра
Пригласить эксперта
Ответы на вопрос 8
Я бы при составлении документации думал примерно так.

Есть новый сотрудник в вакууме. Он должен иметь возможность выяснить основной объем данных по конфигурации оборудования/ПО, по которым могут возникнуть вопросы, не обращаясь к тебе.

Могу быть не прав, но мне кажется, что это основная цель.
Ответ написан
Комментировать
foxmuldercp
@foxmuldercp
Системный администратор, программист, фотограф
обычно это все нормально отстроенная система мониторинга плюс документация по конкретным серверам/сервисам/оборудованию + карта сети/зависимостей (часто в системе мониторинга)
Ответ написан
Комментировать
@divetoh
Правильно - так, чтобы документирование помогало решать типовые и аварийные вопросы и отнимало минимум времени и нервов. Для каждой организации хорошая документация будет выглядеть по-разному. Материалов много (на вскидку: 1, 2, 3, 4), смотри, читай, выбирай то, что для тебя актуально. Ну и старайся не плодить документы с похожими данными, если после переноса сервера из одной стойки в другую требуется изменить три xls файла, внести правки в вики в пяти местах и исправить четыре схемы в визио, то вероятность того, что через несколько лет в этих документах будет разная информация весьма велика.
Wiki - очень неплохое средство вести общую документацию, особенно при наличии нескольких администраторов, но одной wiki мало.
Ответ написан
Комментировать
vvpoloskin
@vvpoloskin
Инженер связи
Если не хочешь ничего придумывать и не лень много возиться - разок сделайте исполнительную документацию полную (да-да, обычный гостовый doc-файл), а дальше просто актуализируйте)
Ответ написан
Комментировать
fallen8rwtf
@fallen8rwtf
я использую racktables для железа и подробной спецификации оборудования и несколько больших примитивных excel-файлов
Ответ написан
Комментировать
afiskon
@afiskon
Вики или markdown в репозитории. На вики по моему опыту все забивают. Чтобы не забивали можно проверить наличие документации при pool request. Но лучше генерировать автоматически инструментами типа Javadoc, DSL-ями какими-то (тут от задачи зависит) и тд.
Ответ написан
Комментировать
Singaporian
@Singaporian
Чем дольше живу, тем чаще склоняюсь к мысли, что настроенная по всем стандартам система не требует документации. Как у программистов: хороший код - сам себе и есть документ.
Ответ написан
Комментировать
Посмотри glpi - вполне адекватная ИС для IT-инфраструктуры
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы