ІТ-документація та документація мережі: щоб інші розібралися

Коротко: Хороша ІТ-документація актуально фіксує план мережі, адреси, конфігурації, доступи й порядок дій, щоб інциденти розв’язувалися швидше і стала можливою заміна співробітників.

Докладніше: «Це знає лише Макс» — ризик. Документація заощаджує години в екстреній ситуації, полегшує введення в посаду, аудити та передавання справ. Вона має бути актуальною, знаходимою та захищеною.

Подробиці

Що документується

• План мережі (логічний: підмережі/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. Журнал змін із датою. Це також робить зміну (новий маршрутизатор, новий адміністратор) безболісною. Див. план мережі, план кабелів, інвентар.

Див. також: План мережі та діаграма Ґанта, План кабельної системи, Керування ІТ-активами