5.7 KiB
5.7 KiB
Capability: <название>
Purpose
<Бизнес-функция capability и понятный результат, не менее 50 знаков.>
Границы
- <область ответственности capability>.
Requirements
Requirement: <название завершённой технической функции>
ID: AREA.CAP-01
Система SHALL <наблюдаемый результат завершённой функции>.
Scenario: <название завершённого процесса>
Участники
- <участники процесса>.
Предусловия
- <условия начала процесса>.
Основной поток
- <Что делаем — как делаем> по AREA.CAP-01.FR-01.
- Завершаем с
FUNCTION_COMPLETED— фиксируем результат по AREA.CAP-01.FR-02.
Альтернативы и ошибки
- <условие ошибки> — завершаем с
FUNCTION_FAILEDпо AREA.CAP-01.FR-02.
Результат
<Наблюдаемое состояние после завершения>.
Коды завершения
| Код | Смысл | Связанные FR |
|---|---|---|
FUNCTION_COMPLETED |
<самодостаточный смысл успешного завершения> | AREA.CAP-01.FR-02 |
FUNCTION_FAILED |
<самодостаточный смысл ошибки> | AREA.CAP-01.FR-02 |
Функциональные требования
AREA.CAP-01.FR-01: Правило обработки
<Обычный FR описывает логику, правило или последовательность шагов. Для специального формата добавь метку после ID: [DB], [API] или [UI]. Структуру таблицы БД и контракт сообщения оформи по соответствующему паттерну. Контракт HTTP endpoint располагай в завершающем разделе CONTRACT.>
AREA.CAP-01.FR-02: Коды завершения, тексты и дальнейшее поведение
| Код | Текст сообщения | Дальнейшее поведение |
|---|---|---|
FUNCTION_COMPLETED |
<текст или явное отсутствие сообщения> | <следующие действия> |
FUNCTION_FAILED |
<текст ошибки> | <обработка ошибки, повтор, действие оператора> |
<При необходимости — параметры сообщений, связанные требования и соответствие действующему runtime. Явно отметь коды и тексты, которые ещё не реализованы.>