# Documentation Rules Index

Этот каталог содержит локализованную проекцию правил построения документации проекта.
Источником истины для структуры и качества документов являются process-документы:
- `/Users/alex/Dev_projects_v2/ai driven app process/v2/agent/_process/01. Process.md`
- `/Users/alex/Dev_projects_v2/ai driven app process/v2/agent/_process/04. Analitycs artefacts.md`

Файлы ниже не должны противоречить этим документам, а лишь конкретизируют их для `test_echo_app`.

## Порядок использования

1. Сначала прочитать `global/documentation-system.md`.
2. Затем прочитать `global/frontmatter.md` и `global/linking.md`.
3. Затем выбрать правило из `artifact-types/` по `doc_type`.
4. Затем использовать шаблон из `templates/`.
5. Для уточнения отдельных частей документа использовать правила из `sections/`.

## Структура каталога

- `global/` — общие правила системы документации.
- `artifact-types/` — правила по типам артефактов.
- `sections/` — правила для отдельных секций документов.
- `templates/` — шаблоны документов.

## Содержимое

### Global
- `global/documentation-system.md`
- `global/frontmatter.md`
- `global/writing-style.md`
- `global/linking.md`
- `global/naming.md`

### Artifact types
- `artifact-types/api_method.md`
- `artifact-types/logic_block.md`
- `artifact-types/architecture_overview.md`
- `artifact-types/domain_entity.md`
- `artifact-types/ui_page.md`
- `artifact-types/integration_doc.md`

### Sections
- `sections/summary.md`
- `sections/details.md`
- `sections/api-scenario.md`
- `sections/api-contract.md`
- `sections/requirements-format.md`

### Templates
- `templates/api_method.template.md`
- `templates/logic_block.template.md`
- `templates/architecture_overview.template.md`
- `templates/domain_entity.template.md`
