ИТ-документация и документация сети: чтобы другие разобрались

Коротко: Хорошая ИТ-документация актуально фиксирует план сети, адреса, конфигурации, доступы и порядок действий, чтобы инциденты решались быстрее и стала возможна замена сотрудников.

Подробнее: «Это знает только Макс» — риск. Документация экономит часы в экстренной ситуации, облегчает введение в должность, аудиты и передачу дел. Она должна быть актуальной, находимой и защищённой.

Подробности

Что документируется

• План сети (логический: подсети/VLAN/маршрутизаторы/межсетевой экран; физический: площадки, стойки, патч-панели, розетки).
• План IP-адресов (диапазоны, статические адреса, пулы DHCP, DNS-имена).
• Устройства/инвентарь (серийный номер, местоположение, ответственные лица).
• Конфигурации (экспорты маршрутизаторов/коммутаторов/межсетевых экранов, роли серверов, версии), зависимости.
• Доступы (в менеджере паролей/хранилище, а не открытым текстом в вики).
• Порядок действий/runbook (резервное копирование, восстановление, переустановка, аварийные случаи).
• Изменения (changelog), договоры/SLA/лицензии, контакты.

Инструменты и форма

• Диаграммы: draw.io/diagrams.net, Visio, Excalidraw, Mermaid/PlantUML (диаграммы как код, можно версионировать).
• Вики/база знаний: Confluence, BookStack, Wiki.js, Obsidian, Markdown в репозитории Git (docs-as-code).
• Сетевые инструменты: NetBox (IPAM/DCIM), phpIPAM; автоматически создаваемая документация (экспорты, Ansible facts).
• Стандарты: единое именование (например, sw-bk-01), шаблоны, версия/дата, владелец каждого документа.
• Актуальность: документирование часть задачи (изменение → документы), регулярные проверки; устаревшая документация опасна.

Хорошая практика

• Учитывайте аудиторию: руководство для новичков или подробный справочник.
• Коротко, точно, со скриншотами/диаграммами, примерами и командами.
• Обосновывайте решения (почему именно так?).
• Права доступа: не всем нужно видеть всё; планы сети и учётные данные чувствительны (план атаки!).
• Резервируйте документацию (не только в системе, которая выходит из строя; аварийная распечатка/автономная копия).
• Проверка: может ли кто-то другой решить задачу по документации?
• Для проектов/выпускного экзамена: документация с анализом цель/факт, планом сети, концепцией, тестами, передачей.

Пример: мини-документация сети для домашней/офисной сети

1. Диаграмма: Интернет → маршрутизатор/межсетевой экран (192.168.1.1) → коммутатор → клиенты/NAS/принтер; SSID Wi-Fi (гостевая отделена).
2. Таблица: устройство, IP, MAC, местоположение, назначение.
3. Диапазон DHCP 192.168.1.100–199, фиксированные IP .10–.50.
4. Доступы в менеджере паролей (администратор маршрутизатора, Wi-Fi, NAS).
5. Аварийный случай: сбросить маршрутизатор, файл резервной копии конфигурации (дата), горячая линия провайдера.
6. Журнал изменений с датой. Это также делает изменение (новый маршрутизатор, новый администратор) безболезненным. См. план сети, план кабелей, инвентарь.

См. также: План сети и диаграмма Ганта, План кабельной системы, Управление ИТ-активами