Использование

Документация Karometr используется как единый источник требований, решений и рабочих договорённостей по продукту.

Как работать с разделами

1. Начинайте с главного раздела проекта.
2. Для планирования сроков и этапов используйте Roadmap.
3. Для реализации функционала опирайтесь на Техническое задание.
4. Для UI/UX решений используйте Дизайн-систему и Карту страниц.
5. Для данных, метрик и визуализации переходите в Аналитику.

Быстрый поиск информации

• Используйте поиск в шапке сайта (Cmd/Ctrl + K).
• Ищите по ключевым словам: модуль, индекс, регион, ABAC, API Gateway.
• Проверяйте связанные разделы по внутренним ссылкам в конце страниц.

Обновление материалов

• Контент хранится в content/ в формате .md и .yml.
• Каждый документ должен иметь title и description в frontmatter.
• Названия файлов должны отражать структуру раздела и порядок чтения.
• При изменении требований обновляйте связанные документы, а не только одну страницу.

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

• Фиксируйте решения коротко и предметно: проблема, решение, последствия.
• Для продуктовых изменений сначала обновляйте roadmap и technical-specification.
• Для изменений модели данных синхронно правьте разделы аналитики и архитектуры.
• Для изменений доступа и ролей синхронно обновляйте раздел безопасности.

Минимальный маршрут для нового участника

1. Обзор Karometr
2. Roadmap
3. Техническое задание
4. Архитектура