docs(specs): archive documentation entrypoints remediation

This commit is contained in:
2026-08-24 10:29:00 +03:00
parent 800450d075
commit 5b7bc0fdaf
15 changed files with 613 additions and 11 deletions
@@ -0,0 +1,42 @@
## ADDED Requirements
### Requirement: Устойчивая документация имеет доступные фактические точки входа
Репозиторий `docs` SHALL содержать indexes архитектуры, разработки и фич,
которые ведут разработчика или AI-агента к фактической устойчивой документации
без обращения к архивированному change или корневому delivery-plan файлу.
Архитектурная документация MUST содержать system overview поставленных
возможностей и локальных границ, канонический domain glossary, а также
Mermaid-диаграммы потоков auth/session и T-Bank → клиент. Feature documentation
MUST предоставлять index поставленных фич и MUST NOT описывать поставленные
Brokerage Accounts, Portfolio, Account Ledger или Future Cash Events как
отложенные.
#### Scenario: Новый участник находит поставленную систему
- **WHEN** новый участник открывает устойчивую документацию
- **THEN** он может перейти из index к system overview, glossary, документам
поставленных фич и соответствующему development workflow
#### Scenario: Участник различает близкие доменные понятия
- **WHEN** участнику нужно описать cached portfolio data или account operation
- **THEN** канонический glossary различает Client Cached Snapshot и Portfolio
Snapshot, а также Future Cash Event и Ledger Entry
### Requirement: README репозиториев являются компактными onboarding entrypoints
Репозитории frontend и backend SHALL предоставлять русскоязычные README
entrypoints, которые указывают Node 22, lockfile-safe bootstrap, локальные
non-mutating verification commands, требуемую локальную configuration и ссылки
на authoritative или just-in-time documentation. README MUST различать deferred
check и passing verification gate, а detailed rationale deferred Prisma e2e и
его review trigger MUST быть ссылкой на remediation registry, а не дублироваться.
#### Scenario: Участник bootstrap-ит application repository
- **WHEN** участник открывает frontend или backend README на чистой локальной
машине
- **THEN** он может определить требуемый runtime, подготовить local
configuration, установить зависимости из lockfile и запустить
документированные local gates без угадывания
#### Scenario: Участник видит ограничение backend e2e
- **WHEN** участник читает backend onboarding instructions
- **THEN** он узнаёт, что Prisma e2e gate отложен, и может перейти к
remediation registry за его точным статусом и review trigger