Планування та документація

Skip to content

Це машинний переклад, який може містити помилки!

Добра документація – це різниця між тим, щоб пам’ятати, як працюють речі, і тим, щоб застрягти о 23:00 у неділю, тому що сервер не працює, і ніхто не пам’ятає, як його було налаштовано. Документація, можливо, не найцікавіша частина ІТ-операцій, але це одна з найважливіших.

Чому документувати?

Причина Пояснення
Пам’ять Ви не запам’ятаєте все через шість місяців, і вам це й не потрібно
Співпраця Інші повинні розуміти, що ви зробили, не питаючи вас
Пошук та усунення несправностей Коли щось не так, безцінно знати, що є нормальним
Відновлення Якщо сервер вийде з ладу, вам потрібно знати, як він був налаштований
Відстежуваність Що було змінено, коли і ким?

Skriv dokumentatsiyu dlya “maybutnoho sebe”

Naykrashche praktychne pravylo: pyshy tak, niby ty povinyuyesh pidlyshuvaty sobi samomu cherez shist’ misyatsiv. Toho chasu ty zabezpechysh, shcho vklyuchysh dostatnyo detaley bez nadmirnoho utskladnennya.

Типи документації в ІТ-експлуатації

Мережева схема

Мережева схема показує фізичну та/або логічну структуру мережі. Це може бути все, від простого ескізу до детальної діаграми з VLAN, IP-адресами та правилами брандмауера.

Добра мережева схема повинна містити:

  • Усі мережеві пристрої (комутатори, маршрутизатори, брандмауери, точки доступу)
  • Структуру VLAN з підмережами
  • IP-адреси для важливих пристроїв (сервери, шлюз)
  • З’єднання між пристроями

IP-план

IP-план – це огляд того, як IP-адреси розподілені в мережі. Він допомагає вам підтримувати порядок і уникати конфліктів (дві одиниці з однією й тією ж адресою).

Приклад:

VLAN Назва Підмережа Шлюз DHCP-діапазон Примітки
10 Адміністрація 10.0.10.0/24 10.0.10.1 .100 - .200 Обмежений доступ
20 Працівники 10.0.20.0/24 10.0.20.1 .100 - .250
30 Студенти 10.0.30.0/24 10.0.30.1 .100 - .250 Лише інтернет
50 Сервери 10.0.50.0/24 10.0.50.1 Немає (статичний) Фіксовані IP-адреси

Статичні адреси:

IP-адреса Одиниця Роль
10.0.50.10 web-01 Nginx
10.0.50.11 db-01 PostgreSQL
10.0.50.12 monitoring-01 Grafana + Loki
10.0.50.20 proxmox Hypervisor

Списки перевірки

Списки перевірки забезпечують, щоб нічого не було забуто. Вони особливо корисні для завдань, які ви виконуєте рідше, таких як налаштування нового сервера або проведення перевірки безпеки.

Приклад: Список перевірки для нового Linux-сервера:

  • Встановити операційну систему (Debian/Ubuntu)
  • Оновити всі пакети (sudo apt update && sudo apt upgrade)
  • Створити користувача з доступом sudo
  • Вимкнути вхід root через SSH
  • Налаштувати брандмауер (ufw)
  • Встановити необхідне програмне забезпечення
  • Налаштувати резервне копіювання
  • Задокументувати сервер у плані IP-адрес
  • Перевірити, чи працює служба

Документація змін

Щоразу, коли ви вносите зміни в виробниче середовище (сервер, мережа, служба), ви повинні це задокументувати. Простого журналу може бути достатньо:

## Endringslogg

### 2026-04-14 - Oppgradert Nginx
- **Hva:** Oppdatert Nginx fra 1.24 til 1.26
- **Hvorfor:** Оновлення безпеки (CVE-2025-XXXX)
- **Hvem:** Ola
- **Resultat:** OK, без простоїв

### 2026-04-10 - Nytt VLAN for IoT
- **Hva:** Створено VLAN 40 для IoT-пристроїв
- **Hvorfor:** Ізолювати IoT від решти мережі
- **Hvem:** Kari
- **Resultat:** OK, всі принтери перенесені до VLAN 40

Bruk Git!

Якщо ви пишете документацію у файлах Markdown (рекомендовано), ви можете контролювати версії за допомогою Git. Тоді ви автоматично матимете історію всіх змін, і зможете побачити, хто і коли змінив що.

Оперативна документація

Оперативна документація описує, як система функціонує в її поточному стані:

Що Приклад
Архітектура системи “Ми запускаємо Proxmox з 3 віртуальними машинами: web, db, monitoring”
Інформація про доступ “SSH через порт 22, тільки з VPN”
Процедури резервного копіювання “Щоденне резервне копіювання о 02:00 на зовнішній диск”
Контактна інформація “У разі проблем звертайтеся до Ola (admin)”
Етапи відновлення “Перезапуск за допомогою: sudo systemctl restart nginx“

Інструменти для документації

Інструмент Для чого використовується Переваги
Markdown Текст з простим форматуванням Легкий, портативний, працює з Git
draw.io Діаграми та мережеві карти Безкоштовний, візуальний, експорт в зображення
Obsidian Нотатки з Markdown та посиланням Гарний для особистої бази знань
MkDocs Публікує Markdown як веб-сайт Професійна документація
Git/GitHub Контроль версій документації Історія, співпраця, резервне копіювання

Easy Завдання 1 - Створіть просту мережеву схему

Використовуйте draw.io (безкоштовно) для малювання мережі вдома або в школі:

  1. Почніть з інтернет-з’єднання та маршрутизатора
  2. Додайте комутатори та точки доступу
  3. Намалюйте сервери, ПК та інші пристрої
  4. Вкажіть IP-адреси там, де ви їх знаєте

Не обов’язково робити ідеально. Головне – почати візуально мислити про мережу.

Easy Завдання 2 - Створіть власний контрольний список

Подумайте про те, що ви регулярно робите з IT (наприклад, налаштування нової VM, встановлення машини розробника або конфігурація VS Code). Складіть контрольний список для цього процесу:

  • Які всі кроки?
  • Що ви найчастіше забуваєте?
  • Чи можете ви спростити деякі кроки?

Збережіть його в документі Markdown, щоб ви могли використовувати його наступного разу.

Medium Завдання 3 - Документуйте один зі своїх сервісів

Оберіть сервіс, який ви налаштували (VM, Docker-контейнер, веб-сервер) і напишіть коротку документацію з експлуатації:

  • Що робить сервіс?
  • Як запустити/зупинити його?
  • Яка IP-адреса та порт?
  • Чи є резервна копія?

Напишіть це у Markdown і розмістіть у Git-репозиторії.

Підсумок

  • Документи для майбутнього вас: Пишіть так, ніби пояснюєте людині, яка нічого не знає
  • Мережеві схеми та IP-плани надають огляд інфраструктури
  • Чек-листи забезпечують, щоб нічого не забувалося під час повторюваних завдань
  • Журнали змін відстежують, що було зроблено, коли та ким
  • Документація з експлуатації описує, як системи працюють сьогодні
  • Використовуйте Markdown + Git для простої, контрольованої версіями документації