Template
107 lines
5.7 KiB
Markdown
107 lines
5.7 KiB
Markdown
# Capability: <название>
|
||
|
||
## Purpose
|
||
|
||
<Бизнес-функция capability и понятный результат, не менее 50 знаков.>
|
||
|
||
<!-- Включай только сведения, меняющие поведение, контракт или обязательное
|
||
ограничение. Удаляй повторы и пояснения без такого влияния. -->
|
||
|
||
## Границы
|
||
|
||
- <область ответственности capability>.
|
||
|
||
## Requirements
|
||
|
||
### Requirement: <название завершённой технической функции>
|
||
|
||
**ID:** `AREA.CAP-01`
|
||
|
||
Система SHALL <наблюдаемый результат завершённой функции>.
|
||
|
||
#### Scenario: <название завершённого процесса>
|
||
|
||
##### Участники
|
||
|
||
- <участники процесса>.
|
||
|
||
##### Предусловия
|
||
|
||
- <условия начала процесса>.
|
||
|
||
##### Основной поток
|
||
|
||
1. <Что делаем — как делаем> по [AREA.CAP-01.FR-01](#areacap-01fr-01-правило-обработки-или-устойчивый-контракт).
|
||
2. Завершаем с `FUNCTION_COMPLETED` — фиксируем результат по [AREA.CAP-01.FR-02](#areacap-01fr-02-коды-завершения-тексты-и-дальнейшее-поведение).
|
||
|
||
##### Альтернативы и ошибки
|
||
|
||
- <условие ошибки> — завершаем с `FUNCTION_FAILED` по [AREA.CAP-01.FR-02](#areacap-01fr-02-коды-завершения-тексты-и-дальнейшее-поведение).
|
||
|
||
##### Результат
|
||
|
||
<Наблюдаемое состояние после завершения>.
|
||
|
||
##### Коды завершения
|
||
|
||
| Код | Смысл | Связанные FR |
|
||
| --- | --- | --- |
|
||
| `FUNCTION_COMPLETED` | <самодостаточный смысл успешного завершения> | [AREA.CAP-01.FR-02](#areacap-01fr-02-коды-завершения-тексты-и-дальнейшее-поведение) |
|
||
| `FUNCTION_FAILED` | <самодостаточный смысл ошибки> | [AREA.CAP-01.FR-02](#areacap-01fr-02-коды-завершения-тексты-и-дальнейшее-поведение) |
|
||
|
||
#### Функциональные требования
|
||
|
||
##### AREA.CAP-01.FR-01: Правило обработки
|
||
|
||
<Обычный FR описывает логику, правило или последовательность шагов. Для
|
||
специального формата добавь метку после ID: [DB], [API] или [UI]. Структуру
|
||
таблицы БД и контракт сообщения оформи по соответствующему паттерну. Контракт
|
||
HTTP endpoint располагай в завершающем разделе CONTRACT.>
|
||
|
||
##### AREA.CAP-01.FR-02: Коды завершения, тексты и дальнейшее поведение
|
||
|
||
| Код | Текст сообщения | Дальнейшее поведение |
|
||
| --- | --- | --- |
|
||
| `FUNCTION_COMPLETED` | <текст или явное отсутствие сообщения> | <следующие действия> |
|
||
| `FUNCTION_FAILED` | <текст ошибки> | <обработка ошибки, повтор, действие оператора> |
|
||
|
||
<При необходимости — параметры сообщений, связанные требования и соответствие
|
||
действующему runtime. Явно отметь коды и тексты, которые ещё не реализованы.>
|
||
|
||
<!-- HTTP endpoint описывай в отдельном Requirement с полным Use case.
|
||
Контракт размещай в конце Requirement, не разбивая request/response на FR:
|
||
|
||
#### CONTRACT
|
||
|
||
##### Request
|
||
|
||
Метод: `POST`; путь: `/resource`. <Тело запроса или явное отсутствие тела.>
|
||
|
||
##### Response
|
||
|
||
HTTP status: <код и условие возврата>.
|
||
|
||
| Поле | Тип | Обязательность | Ограничения и значение по умолчанию | Назначение | Формирование значения |
|
||
| --- | --- | --- | --- | --- | --- |
|
||
| `field_name` | `JSON type` | <Обязательное или опциональное> | <Ограничения> | <Назначение> | <Источник или правило формирования> |
|
||
-->
|
||
|
||
<!-- Автор выбирает полный или сокращенный Use case по ситуации, независимо от
|
||
типа FR и предмета описания. Для сокращенного Use case используй только основной
|
||
поток и ссылки на FR:
|
||
|
||
#### Scenario: Сокращенный use case: <предмет описания>
|
||
|
||
##### Основной поток
|
||
|
||
1. <Кратко опиши первый аспект> по [AREA.CAP-01.FR-01](#areacap-01fr-01-правило-обработки).
|
||
2. <Кратко опиши следующий аспект> по [AREA.CAP-01.FR-02](#areacap-01fr-02-правило-или-контракт).
|
||
-->
|
||
|
||
<!-- Типы FR: без метки — логика и правила; [DB] — структура БД;
|
||
[API] — контракт сообщения или технического лога; [UI] — требования к UI.
|
||
[DB] с таблицей оформляй по openspec/schemas/function-driven/patterns/database-table.md.
|
||
Сериализуемый контракт FR [API] оформляй по
|
||
openspec/schemas/function-driven/patterns/message-contract.md. В response-таблице
|
||
добавь колонку «Формирование значения» для каждого поля. -->
|