# Documentation Rules V3 Этот каталог содержит правила генерации технической документации из системной аналитики. ## Цель - синхронизировать требования к документации с требованиями к аналитике (`04. Analitycs artefacts - features.md`); - сохранить детальность техдокументации по сравнению с аналитикой; - убрать дублирование структуры и manifest-слоя между разными файлами; - собирать итоговый промпт из модулей: глобальные правила + template с manifest + блоки. ## Структура - `documentation-rules.md` — верхнеуровневый регламент и порядок сборки. - `global/` — общие правила (заголовки, frontmatter, слой ответственности, мост аналитика->документация). - `common-elements/` — правила для общих блоков (`summary`, `details`, `use case`, `FR`, `NFR`, `UI`, `Contract`). - `templates/` — единственный источник истины для структуры итоговой страницы и manifest-метаданных типа документа. ## Принцип сборки Для конкретного документа агент собирает единый набор правил из: 1. `documentation-rules.md` 2. `global/*.md` 3. `templates/.template.md` 4. `common-elements/*.md`, указанных в frontmatter template ## Правило без дублирования - `templates/` отвечают за структуру документа, порядок разделов и manifest-метаданные типа. - `common-elements/` отвечают только за правила написания конкретного раздела. - отдельный слой `types/` не нужен, если для типа документа используется один основной template. ## Формат template-manifest Manifest оформляется в YAML frontmatter самого template. Обязательные поля manifest: - `doc_type` - `required_common_elements` Рекомендуемые поля: - `special_rules`