Документирование прецедентов

Структура документа, описывающего прецеденты, может варьироваться, однако типичное описание должно содержать следующие разделы.

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

2. Участвующие субъекты.

3. Предусловия, необходимые для инициирования прецедента.

4. Детализированное описание потока событий, которое включает:

· основной поток, который можно разбить для того, чтобы показать подчиненные потоки событий (подчиненные потоки могут быть разделены дальше на еще более мелкие потоки, с целью сделать читаемость документа более удобной);

· альтернативные потоки для определения исключительных ситуаций.

5. Постусловия, определяющие состояние системы, по достижении которого прецедент завершается.

Приведем описательную документацию всех обозначенных выше прецедентов.

 

Таблица 1. Описательная спецификация прецедента Добавить новый ресурс

Краткое описание	Прецедент даёт возможность добавить новый ресурс.
Субъекты	Пользователь, Система каталога(Сервер)
Предусловия	Обращение к браузеру.
Основной поток событий	Для того, чтобы добавить новую страницу пользователь с помощью Интернет-браузера заполняет форму и посылает запрос на сервер. Сервер проверяет новый ресурс, присваивает ему URL, заносит в свою БД и помещает в общий каталог ресурсов.
Альтернативные потоки	Неправильно или не полностью заполнены поля формы. Система отображает на экране сообщение об ошибке и просит ввести пропущенную информацию. Если система не находит этот ресурс, то он не заносится в БД и каталог
Постусловия	Если прецедент был успешным, то сервер поместит новый ресурс в каталог.

 

 

Таблица 2. Описательная спецификация прецедента Получить полный список ресурсов

 

Краткое описание	Сервер отображает каталог. Пользователь видит полный каталог.
Субъекты	Пользователь. Система каталога(сервер)
Предусловия	Пользователь обращается к браузеру.
Основной поток событий	Сервер помещает ресурсы в каталог и отображает. Пользователь получает к ним доступ.
Альтернативные потоки	Отсутствуют
Постусловия	Если прецедент был успешным, пользователь получит доступ к каталогу.

 

 

Таблица 3. Описательная спецификация прецедента Опросить WEB-сайты.

 

 

Краткое описание	Сервер следит за содержанием ресурсов Интернет, за датой последнего обновления, опрашивая Сайты, адреса которых хранятся в каталоге
Субъекты	Система каталога(Сервер)
Предусловия	Необходимо иметь все URL адреса.
Основной поток событий	Система с определённым интервалом посылает запросы на URL сайтов, которые хранятся у него в БД. Сверяет данные, если они обновились, то он обновляет их в свое БД.
Альтернативные потоки	Если информация осталась без изменения, то сервер ничего не изменяет.
Постусловия	Если прецедент был успешным, то обновление произошло.

Таблица 4. Описательная спецификация прецедента Найти ресурс

 

Краткое описание	В специальном месте в браузере пользователь пишет то, что ему необходимо найти и посылает на сервер.
Субъекты	Пользователь. Система каталога.
Предусловия	Воспользоваться браузером
Основной поток событий	Пользователь посылает на сервер запрос о том, что ему необходимо найти. Сервер производит поиск в своей БД и отображает на экране информацию о поиске.
Альтернативные потоки	Если сервер не нашёл нужную информацию, то выдаёт сообщение об этом.
Постусловия	Если прецедент успешный, пользователь получит информацию.

 

 

Таблица 5. Описательная спецификация прецедента Поиск среди найденных результатов

Краткое описание	Данный прецедент позволяет произвести поиск уже в полученной информации
Субъекты	Пользователь
Предусловия	Воспользоваться поиском
Основной поток событий	Пользователь посылает запрос на поиск в найденном.
Альтернативные потоки	Отсутствуют
Постусловия	Если прецедент был успешным, то пользователь получит необходимую информацию.

 

Таблица 6. Описательная спецификация прецедента Сортировка результатов поиска

 

Краткое описание	Пользователь имеет возможность отсортировать результаты поиска (по рейтингу, по дате)
Субъекты	Пользователь
Предусловия	Получение выбранной информации
Основной поток событий	Пользователь может отсортировать результаты поиска (по дате, по рейтингу). Т.е. задаёт необходимые параметры и посылает на сервер. Сервер сортирует информацию и выдаёт её пользователю.
Альтернативные потоки	Отсутствуют
Постусловия	Пользователь получает необходимую информацию.

 

Таблица 7. Описательная спецификация прецедента Выбор формы результата

Краткое описание	Пользователь может выбрать форму результата (полную или частичную)
Субъекты	Пользователь
Предусловия	Выбрать форму поиска
Основной поток событий	Пользователь посылает запрос на сервер о том, в какой форме бы он хотел получить информацию. Система выдает сообщение в нужной форме.
Альтернативные потоки	Если пользователь не заполнил форму, то отображается по умолчанию краткая форма.
Постусловия	Если прецедент был успешным, то сервер поместит новый ресурс в каталог.