docs: make project documentation self-contained
This commit is contained in:
@@ -1,17 +1,14 @@
|
||||
# Docs
|
||||
# Документация WealthLedger
|
||||
|
||||
Здесь живут as-built факты, проектные решения и общие engineering conventions.
|
||||
Работай напрямую по задаче пользователя; обязательного SDD lifecycle нет.
|
||||
Этот репозиторий описывает устройство системы, пользовательские возможности,
|
||||
ограничения и причины принятых решений. [Главная страница](README.md) и
|
||||
[тематический индекс](AI_INDEX.md) дают вход в эти знания без доступа к исходникам.
|
||||
|
||||
Для поиска проектного источника начни с [AI_INDEX](AI_INDEX.md). Если задача
|
||||
уже указывает точный документ (например, правка опечатки), читай его напрямую.
|
||||
Architecture/features описывают текущее поведение,
|
||||
ADR сохраняют rationale; audits и прежнее Completion Evidence — история.
|
||||
Изменение утверждённого архитектурного решения фиксируется successor ADR,
|
||||
но не требует создания OpenSpec artifacts.
|
||||
[Правила ведения документации](development/documentation.md) определяют
|
||||
ответственность за актуальность, сохранение смысла и проверку самостоятельности.
|
||||
Архитектурные решения сохраняются в ADR; аудиты и датированные свидетельства
|
||||
остаются историческими материалами и не заменяют описание текущего поведения.
|
||||
|
||||
Перед Node-командами: `nvm use --silent`. После `npm ci` запускай
|
||||
`npm run verify` (Markdown lint + `git diff --check`, без auto-fix).
|
||||
Проверь links/anchors затронутых документов отдельно. Новые документы должны
|
||||
быть доступны через соответствующий index. Runtime facts сверяй с code/config;
|
||||
не копируй framework docs, secrets или один контракт в несколько owners.
|
||||
Локальные проверки документации охватывают Markdown, относительные ссылки
|
||||
и якоря; смысловая согласованность проверяется отдельно. Синтаксическая
|
||||
проверка не гарантирует актуальность архитектурного или функционального факта.
|
||||
|
||||
Reference in New Issue
Block a user