use-case-template.txt

h1. Шаблон варианта использования

h2. Вариант использования функции "Выйти из процесса приёмки товаров ПУО"

|*Основное действующее лицо*|Название роли из классификатора ролей пользователей системы (одной роли)|
|*Предусловия*|Описание проверяемых условий, относящихся к области действия. Например, пользователь авторизован системой. Или, роль пользователя – такая-то. Или «на личном счёте достаточно средства». Т.е. при невыполнении этих предсуловий исполнение ВИ  должно быть недоступно и на уровне программы эти предоусловия должны быть проверены, а для автора тестовых сценариев предусловия – это вообще первое, что надо описывать в тестовых сценариях.|
|*Действие, запускающее вариант использования*| Описание действия, после выполнения которого начинается исполнение основного сценария (например, активация пункта меню)|
|*Уровень:*|	Одно из трёх: функции/цели пользователя/подсистемы. Функции – это внутренний, системный вариант исползования, в котором не участвует пользователь человек или сторонние системы. Цели пользователя – это вариант использования, исполнение которого позволяет достичь какой-то цели какому-то из пользователей. Например, положить товар в корзину, подписаться на получение обновлений RSS или определить маршрут движения.|
|*Область действий:*|Указываем Наименование модуля, в котором действует ВИ, или же подсистему. Т.е. здесь мы указываем в какой области действует данный вариант использования|

h3. Краткое описание

Очень краткая (одно-два предложения) формулировка варианта использования в формате, напоминающем сжатую пользовательскую историю.

h3. Основной сценарий

# Простыми предложениями описываем действия участников, например
## Оператор шпалоукладчика рукояткой управления хоботом подводит хобот к шпале
# Никаких если и т.п. Только прямой успешный сценарий, который происходит, когда всё идёт, как нужно
 

h3. Альтернативные сценарии

1.1.1 Альтернативные сценарии служат для указания возможных расширений при наступлении каких-то условий на некоторых шагах основного сценария
1.1.1.2 Например на шаге 2 основного может быть какое-то ответвление например. Тогда мы в альтернативных пишем: 2.1 текст условия (напр. Рукоятка отсутствует) – и дальше шаги действий в этом случае

h3. Критерий успеха, постусловия

Указывается критерий, который может быть проверен по результатам выполнения ВИ для оценки успешности его выполнения, так же указываются все условия, которые необходимо проверить для того, чтобы удостовериться в корректном выполнении ВИ.

h3. Прочие действующие лица

Указываются роли прочих действующих лиц, а так же компоненты системы или других систем, с которыми взаимодействует ОДЛ

h3. Примечания и нефункциональные требования

Пишем нефункциональные требования, например данный ВИ должен выполняться 200 раз в секунду. Или его исполнение не должна занимать больше 5 минут. А так же прочие примечания.