PLBA2-1. Спецификация

This commit is contained in:
2026-10-10 18:19:37 +03:00
commit c540f591b9
37 changed files with 3921 additions and 0 deletions
+33
View File
@@ -0,0 +1,33 @@
schema: function-driven
context: |
Актуальные спецификации проекта находятся в openspec/specs/.
Старые документы spec/specs/ устарели и не подтверждают текущее поведение.
Capability имеет отдельную бизнес-функцию или понятный результат и живёт
в иерархии доменов, например orders/snapshot-sync.
Requirement описывает одну завершённую техническую функцию.
Формат требований определяется локальной схемой function-driven.
Включай только сведения, влияющие на наблюдаемое поведение, устойчивый
контракт или обязательное техническое ограничение; не добавляй повторы и
пояснительный текст без такого влияния.
Пиши спецификации по-русски; имена API, SQL-полей и кодов сохраняй.
rules:
specs:
- Каждый Requirement содержит ровно один Use case. Автор выбирает полный или сокращенный формат независимо от типа FR и предмета описания.
- Обычный FR без метки описывает логику, правила или последовательность шагов; специальные типы помечай в заголовке FR как [DB], [API] или [UI].
- FR [DB] с таблицей БД оформляй по openspec/schemas/function-driven/patterns/database-table.md.
- Каждый HTTP endpoint описывай отдельным Requirement с полным Use case; сложные шаги выноси в FR и связывай со сценарием.
- Контракт endpoint помещай после FR в завершающий CONTRACT с подразделами Request и Response; не создавай для request/response отдельные FR.
- Таблицы тела запроса и ответа в CONTRACT оформляй по openspec/schemas/function-driven/patterns/message-contract.md; для каждого поля Response указывай источник или правило формирования значения.
- Сериализуемые контракты сообщений и технических логов описывай в FR [API] по openspec/schemas/function-driven/patterns/message-contract.md; один FR описывает одно направление.
- Детали находятся в локально нумерованных FR за пределами Scenario; шаги ссылаются на FR.
- Коды завершения сами передают смысл результата и связаны с FR о текстах и дальнейшем поведении.
- Для master spec используй templates/main-spec.md выбранной схемы; для delta используй templates/spec.md.
- Проверяй формат командой python3 openspec/schemas/function-driven/validate_format.py <spec-path>.
proposal:
- Сохраняй полные иерархические пути capabilities.
design:
- Ссылайся на Requirement ID и локальные FR; описывай решения реализации без копирования требований.
tasks:
- Связывай задачи с Requirement ID, FR и кодами завершения, если задача затрагивает эти результаты.