Рефакторинг документації
Рефакторинг структури документації проєкту з адаптацією до типу проєкту:
- Аналіз проєкту: Визначити тип (бібліотека/API/веб-додаток/CLI/мікросервіси), архітектуру та персони користувачів
- Централізація документації: Перемістити технічну документацію до
docs/з належними перехресними посиланнями - Кореневий README.md: Оптимізувати як точку входу з оглядом, швидким стартом, резюме модулів/компонентів, ліцензією, контактами
- Документація компонентів: Додати README файли на рівні модулів/пакетів/сервісів з інструкціями налаштування та тестування
- Організація
docs/за відповідними категоріями:- Архітектура, Довідник API, База даних, Дизайн, Усунення несправностей, Деплой, Контрибʼюція (адаптувати до потреб проєкту)
- Створення посібників (оберіть застосовні):
- Посібник користувача: Документація для кінцевих користувачів додатків
- Документація API: Ендпоінти, автентифікація, приклади для API
- Посібник розробника: Налаштування, тестування, процес контрибʼюції
- Посібник деплою: Деплой на продакшн для сервісів/додатків
- Використання Mermaid для всіх діаграм (архітектура, потоки, схеми)
Тримайте документацію лаконічною, зручною для сканування та контекстно відповідною типу проєкту.
Останнє оновлення: 9 квітня 2026