Документация на пользовательские интерфейсы

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

Рис. 3.1. Пример визуального отображения анализа транзакций на этапе логического проектирования.

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

Документация на пользовательские интерфейсы содержит следующие разделы:

Постановка задачи.

При постановке задачи необходимо указать какой тип пользователя будет работать и какие действия будет реализовывать в данном ПИ. Например:

ПИ обеспечивает деятельность оператора по заключению договора на аренду жилья:

· Поиск или ввод клиента;

· Поиск объектов жилья по требованию клиента:

ü По ближайшей станции метро и/или цене «от»-«до»;

ü По количеству комнат и/или метражу жилой площади;

ü По наличию телефона и/или мебели;

· Оформление договора.

Исходные данные.

Исходные для ПИ данные делятся на:

Переданные из БД.

Обычно в ПИ оформляются как поля ввода (текстовые поля). Необходимо перечислить все поля ПИ, которые содержат данные из БД и указать из какой таблицы (поле) они берутся. Например:

· Поле «Полный адрес объекта» берется из таблицы Объект(Адрес)

· Поля ФИО, дата рождения, прописка клиента – таблица Клиент(ФИО, Д_рож, адрес)

· Поля Паспортные данные – таблица Паспорт(номер, серия, кто, когда)

· Поле Стоимость – таблица Объект(ст-ть)

· Количество месяцев.

Введенные вручную.

Обычно в ПИ оформляются как поля ввода (текстовые поля). Необходимо перечислить все поля ПИ, которые вводятся вручную. Например:

· ФИО клиента

· Номер и серия паспорта

· Цена «от»

· Цена «до»

· Начало аренды

· Конец аренды.

Справочные константы.

Обычно в ПИ оформляются как метки, поля ввода (текстовые поля) с уже введенными данными, поля со списком выбора, метки с «переключателем». Необходимо перечислить все поля ПИ, которые содержат справочную информацию и ее источник. Например:

· ближайшая станция метро – список всех станций метрополитена.

Алгоритм решения.

Если в ПИ проводятся какие-либо вычисления, необходимо пояснить их алгоритм либо в виде формул, либо в виде блок-схемы, либо в виде текста с пояснениями. Например:

стоимость по договору = стоимость * количество месяцев

количество месяцев = конец аренды – начало аренды.

Необходимо заметить, что в правой части формулы должны содержаться только данные из пункта 3.3.2, в противном случае их необходимо пояснить следующей формулой.

Макет интерфейса.

Если ПИ имеет только одну экранную форму – представлять нужно только ее, если несколько – представлять нужно все формы с указанием условий переходов и возвратов от одной формы к другой. Например:

Рис. 3.2. Макет пользовательского интерфейса.

Перечень всех управляющих элементов макета.

Необходимо перечислить все управляющие элементы, которые используются в макете ПИ и зафиксировать действия, которые будут выполняться при использовании этих элементов. Удобнее всего это сделать в табличной форме. Например:

Таблица №3.1 Описание управляющих элементов.

Номер управляющего элемента	Имя элемента	Какие действия выполняются
ComboBox1		Позиционирование конкретного оператора
Buttom1	Найти	Поиск данных о клиенте по номеру и серии паспорта
Buttom2	Добавить клиента	Добавление данных о новом клиенте
Buttom3	Просмотреть список договоров клиента	Просмотр всех договоров найденного клиента
ComboBox2		Выбор станции метро из всего списка станций
ComboBox3		Выбор количества комнат из возможного в компании списка (1,2,3,4)
ComboBox4		Выбор типа дома из возможного в компании списка.
Buttom4	Найти	Поиск варианта квартиры по одному или любому набору представленных параметров.
ComboBox5		Выбор месяца
Buttom5	Заключить договор	Добавление данных нового договора. В результате добавления в окне «Номер договора» автоматически появится следующий номер договора. В окне «Количество договоров за день» происходит увеличение на 1. В окне «на сумму» происходит увеличение на сумму добавленного договора.
Buttom6	Распечатать договор	Происходит распечатка шаблона договора, хранящегося в MSWord с добавлениями полей таблицы «Договор»

Программный код.

Макет ПИ реализуется на любом объектно-ориентированном языке программирования. Программный продукт сохраняется на любом носителе, который прилагается к пояснительной записке. В пояснительной записке указывается имя файла, где записан программный код. Распечатка программного кода реализации ПИ на любом объектно-ориентированном языке программирования добавляется к документации.

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