Template
Обновил git процесс
This commit is contained in:
@@ -5,12 +5,20 @@
|
||||
формат требований определён в `schema.yaml` и шаблонах. Существующие changes
|
||||
с явно указанной `schema: spec-driven` продолжают использовать свою схему.
|
||||
|
||||
## Git-процесс проекта
|
||||
|
||||
Схема задаёт порядок и формат OpenSpec-артефактов. Правила веток, двух
|
||||
последовательных PR, ручного слияния и явной команды продолжения находятся
|
||||
в [шаблоне проектных инструкций](../../../examples/project-bootstrap/AGENTS.md).
|
||||
При подключении схемы включите правила из этого шаблона в проектный
|
||||
`AGENTS.md` и согласуйте имя целевой ветки с настройками репозитория.
|
||||
|
||||
## Уровни спецификации
|
||||
|
||||
- Capability — отдельная бизнес-функция или понятный результат в иерархии доменов.
|
||||
- Границы master-спецификации фиксируют ответственность capability: что входит в её область, что исключено и кому принадлежат соседние обязанности.
|
||||
- Requirement — одна завершённая техническая функция, стабильный ID и ровно один Scenario.
|
||||
- Scenario — один из двух форматов Use case: полный или сокращенный. Автор выбирает формат независимо от того, описываются ли БД, API, логика, UI или другая часть системы.
|
||||
- Scenario — один из двух форматов Use case: полный или сокращённый. Формат определяется сложностью сценария, независимо от того, описываются ли БД, API, логика, UI или другая часть системы.
|
||||
- FR — подробные правила и контракты сообщений за пределами Scenario;
|
||||
контракт HTTP endpoint размещается в завершающем CONTRACT.
|
||||
|
||||
@@ -68,8 +76,11 @@ Markdown-рендерер автоматически создаёт якоря
|
||||
|
||||
## Форматы Use case
|
||||
|
||||
Полный Use case содержит Участников, Предусловия, Основной поток, Альтернативы и ошибки, Результат и Коды завершения. Сокращенный Use case содержит только Основной поток; каждый шаг ссылается на FR. Автор выбирает формат для конкретного описания независимо от типа FR и предмета описания.
|
||||
Для каждого HTTP endpoint используй отдельный Requirement и полный Use case.
|
||||
- Полный Use case используй для крупных многошаговых сценариев с большим количеством последовательных действий.
|
||||
- Сокращённый Use case используй для простых коротких требований. Рассматривай их как кандидаты на выделение в отдельные Requirements для переиспользования в сценариях других Requirements.
|
||||
- Выбирай формат по сложности: не используй полный Use case для простых требований, а сокращённый — для объёмных многошаговых сценариев. Правило действует и для HTTP endpoint.
|
||||
|
||||
Полный Use case содержит Участников, Предусловия, Основной поток, Альтернативы и ошибки, Результат и Коды завершения. Сокращённый Use case содержит только Основной поток; каждый шаг ссылается на FR.
|
||||
|
||||
```text
|
||||
#### Scenario: Сокращенный use case: описание функции
|
||||
@@ -106,8 +117,8 @@ FR задаёт тексты, дальнейшие действия и связ
|
||||
|
||||
## HTTP-контракт в Requirement
|
||||
|
||||
Каждый endpoint оформляется отдельным Requirement. Сценарий использует полный
|
||||
Use case; сложные правила шагов выносятся в FR. После всех FR, в конце
|
||||
Каждый endpoint оформляется отдельным Requirement. Формат Use case выбирается
|
||||
по сложности сценария; сложные правила шагов выносятся в FR. После всех FR, в конце
|
||||
Requirement, размещается раздел CONTRACT с подразделами Request и Response.
|
||||
В Request указываются один HTTP-метод и путь, тело и query-параметры. В
|
||||
Response указываются HTTP status и таблица сериализуемого ответа. Не создавай
|
||||
|
||||
Reference in New Issue
Block a user