33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# Documentation Rules
|
|
|
|
## Назначение
|
|
|
|
Этот файл фиксирует общие правила формирования, обновления и поддержки технической документации проекта.
|
|
|
|
Документация проекта должна создаваться как система атомарных, связанных между собой документов, пригодных:
|
|
- для чтения человеком;
|
|
- для сопровождения командой;
|
|
- для индексирования в RAG;
|
|
- для автоматического обновления агентом на основе кода и существующих артефактов.
|
|
|
|
Этот файл задает:
|
|
- общие принципы документационной архитектуры;
|
|
- правила декомпозиции документации;
|
|
- правила размещения файлов;
|
|
- требования к связям между документами;
|
|
- требования к качеству markdown-документов;
|
|
- правила генерации и обновления документации агентом.
|
|
|
|
Детальные шаблоны документов и правила frontmatter описываются отдельно:
|
|
- `.analysis/rules/frontmatter-rules.md`
|
|
- `.analysis/rules/templates/*.md`
|
|
|
|
---
|
|
|
|
## Область действия
|
|
|
|
Правила из этого файла применяются ко всей проектной документации, размещаемой в:
|
|
|
|
```text
|
|
docs/documentation/
|