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

Документація підтримується як код: матеріали зберігаються у Git-репозиторії, проходять перевірку та мають прозору історію змін.

Базові принципи

• Одна стаття — одна зрозуміла задача або тема.
• Використовуйте зрозумілі заголовки, короткі абзаци, списки й таблиці.
• Додавайте посилання на пов'язані процеси та матеріали.
• Оновлюйте документацію разом зі зміною функціональності.
• Зміни мають проходити review через Pull Request.

Перед публікацією

1. Переконайтеся, що інструкція відповідає поточній версії системи.
2. Перевірте посилання, назви екранів і термінологію.
3. Використовуйте скріншоти лише там, де вони справді допомагають; їх потрібно підтримувати актуальними.
4. Узгодьте зміни з власником відповідного розділу.