📚 DOCUMENTATION - Навигация по документации

Проект: {PROJECT_NAME}
Последнее обновление: {ДАТА}

🎯 НАЗНАЧЕНИЕ

Этот документ служит навигацией по всей документации проекта.

📁 СТРУКТУРА ДОКУМЕНТАЦИИ

🔴 Обязательные документы (уровень 1)

Эти документы ВСЕГДА актуальны и поддерживаются:

1. README.md

Для кого: Новые разработчики
Назначение: Точка входа, быстрый старт
Обновляется: При изменении установки/запуска

2. {PROJECT}-PROJECT-MASTER.md

Для кого: Разработчики, архитекторы
Назначение: Источник правды о проекте (архитектура, БД, интеграции)
Обновляется: При изменении архитектуры/моделей

3. {PROJECT}-CHANGELOG.md

Для кого: Все участники проекта
Назначение: История изменений, версии
Обновляется: При каждом релизе

4. DOCUMENTATION.md

Для кого: Все участники проекта
Назначение: Этот файл - навигация по документам
Обновляется: При добавлении/удалении документов

🟡 Рекомендуемые документы (уровень 2)

Создаются для сложных проектов:

{PROJECT}-ROADMAP.md

Для кого: PM, разработчики
Назначение: План развития на 3-6 месяцев, приоритеты
Обновляется: Раз в месяц или при изменении приоритетов

{PROJECT}-API-GUIDE.md

Для кого: Разработчики, интеграторы
Назначение: Справочник API интеграций
Обновляется: При добавлении/изменении API методов

ARCHITECTURE.md

Для кого: Архитекторы, senior разработчики
Назначение: Детальная архитектура, диаграммы
Обновляется: При изменении архитектуры

DEPLOYMENT.md

Для кого: DevOps, разработчики
Назначение: Как деплоить проект
Обновляется: При изменении процесса деплоя

SECURITY.md

Для кого: Security team, разработчики
Назначение: Security checklist, best practices
Обновляется: При обнаружении уязвимостей

SECRETS.md

Для кого: DevOps, администраторы
Назначение: Управление паролями, ключами, ротация секретов
Обновляется: При изменении паролей/ключей

BACKUP.md

Для кого: DevOps, администраторы
Назначение: Стратегия бэкапов, процедуры восстановления
Обновляется: При изменении стратегии бэкапов

MONITORING.md

Для кого: DevOps, SRE
Назначение: Метрики, алерты, логи, health checks
Обновляется: При добавлении метрик/алертов

MAINTENANCE.md

Для кого: DevOps, администраторы
Назначение: Регулярное обслуживание (daily/weekly/monthly задачи)
Обновляется: При изменении процедур обслуживания

TROUBLESHOOTING.md

Для кого: DevOps, support
Назначение: Диагностика проблем, типичные ошибки
Обновляется: При обнаружении новых проблем

RUNBOOK.md

Для кого: Дежурные, операторы
Назначение: Операционное руководство, процедуры
Обновляется: При изменении процедур

TESTING.md

Для кого: Разработчики, QA
Назначение: Стратегия тестирования, coverage требования
Обновляется: При изменении тестовой стратегии

🟢 Опциональные документы (уровень 3)

Создаются по необходимости:

CODE-GUIDE.md

Для кого: Разработчики
Назначение: Стандарты кодирования (может быть универсальным для всех проектов)
Обновляется: При изменении стандартов

WORKFLOWS.md

Для кого: Разработчики
Назначение: Рабочие процессы (добавление фич, релизы)
Обновляется: При изменении процессов

USER-GUIDE.md

Для кого: Конечные пользователи
Назначение: Руководство пользователя
Обновляется: При добавлении функций

CONTRIBUTING.md

Для кого: Контрибьюторы
Назначение: Как контрибьютить в проект
Обновляется: При изменении процесса контрибуции

🗂️ РАСПОЛОЖЕНИЕ ФАЙЛОВ

{PROJECT_NAME}/
├── README.md                          # Точка входа
├── DOCUMENTATION.md                   # Этот файл
├── {PROJECT}-PROJECT-MASTER.md        # Источник правды
├── {PROJECT}-CHANGELOG.md             # История
├── {PROJECT}-ROADMAP.md               # План развития
├── {PROJECT}-API-GUIDE.md             # API справочник
├── CODE-GUIDE.md                      # Стандарты кода
├── WORKFLOWS.md                       # Процессы
├── ARCHITECTURE.md                    # Архитектура
├── DEPLOYMENT.md                      # Развёртывание
├── SECURITY.md                        # Безопасность
├── CONTRIBUTING.md                    # Для контрибьюторов
├── USER-GUIDE.md                      # Для пользователей
└── docs/
    ├── diagrams/                      # Диаграммы (Mermaid, PlantUML)
    ├── screenshots/                   # Скриншоты
    ├── examples/                      # Примеры использования
    └── archive/                       # Устаревшие документы

🔗 ВЗАИМОСВЯЗИ ДОКУМЕНТОВ

README.md
   │
   ├─→ {PROJECT}-PROJECT-MASTER.md ─→ ARCHITECTURE.md
   │                                └─→ {PROJECT}-API-GUIDE.md
   │
   ├─→ {PROJECT}-ROADMAP.md
   │
   ├─→ CODE-GUIDE.md ─→ WORKFLOWS.md
   │
   └─→ DEPLOYMENT.md ─→ SECURITY.md

🔄 LIFECYCLE ДОКУМЕНТОВ

Правило 1: Актуализация

После КАЖДОГО значительного изменения:
1. Обновить дату в документе
2. Добавить запись в CHANGELOG
3. Закоммитить

Правило 2: Ревью

Периодичность: Раз в месяц или перед релизом
- Проверить актуальность
- Обновить устаревшие разделы
- Удалить неактуальное

Правило 3: Архивация

Устаревшие документы → docs/archive/

📖 КАК CLAUDE CODE ИСПОЛЬЗУЕТ ДОКУМЕНТЫ

При запуске проекта

Claude читает:
1. README.md - понять что это за проект
2. DOCUMENTATION.md - какие документы есть
3. {PROJECT}-PROJECT-MASTER.md - детальная информация

При добавлении фичи

Claude читает:
1. {PROJECT}-PROJECT-MASTER.md - текущая архитектура
2. {PROJECT}-ROADMAP.md - приоритеты
3. CODE-GUIDE.md - стандарты
4. WORKFLOWS.md - процесс добавления фичи

При работе с API

Claude читает:
1. {PROJECT}-API-GUIDE.md - методы API
2. {PROJECT}-PROJECT-MASTER.md - список интеграций

🎯 QUICK START ДЛЯ CLAUDE

Я хочу работать с проектом {PROJECT_NAME}

Claude автоматически прочитает:
- README.md
- DOCUMENTATION.md
- {PROJECT}-PROJECT-MASTER.md

И будет готов к работе!

Последнее обновление: {ДАТА}
Автор: {АВТОР}