Руководство пользователя

Software Design Description
Книжный магазин
Дата:
06/04/2008
Книжный магазин, Bookstore, BS
Руководство пользователя
Version 1.0
Software Design Description
Книжный магазин
Дата:
12/24/2007
Содержание
1.
Пример «Книжный магазин. BookStore. BS» ................................................................................. 3
1.1.
Общее описание ................................................................................................................................... 3
2.
Запуск приложения ............................................................................................................................ 4
3.
Работа клиент приложения .............................................................................................................. 5
3.1.
3.2.
3.3.
3.4.
3.5.
3.6.
3.7.
3.8.
3.9.
About ...................................................................................................................................................... 5
Login ....................................................................................................................................................... 5
Signup .................................................................................................................................................... 6
Manage Account .................................................................................................................................... 7
Book List ................................................................................................................................................. 7
Cart ......................................................................................................................................................... 9
Add Book .............................................................................................................................................. 11
User List ............................................................................................................................................... 12
Application ............................................................................................................................................ 13
4.
Работа сервер-приложения ............................................................................................................ 15
5.
Сообщения клиент-приложения .................................................................................................... 16
2
Software Design Description
Книжный магазин
Дата:
12/24/2007
1. Пример «Книжный магазин. BookStore. BS»
1.1.
Общее описание
Данная система является клиент-серверным приложением для персонального компьютера.
Интерфейс состоит из Win32 окон.
В качестве технологий для реализации системы будут использоваться AceTAO и JacORB.
Разработаем систему заказов для книжного магазина, позволяющую:

обновлять и корректировать информацию о книгах, хранящуюся в базе данных
(добавление новых книг, изменение цен и т.д.);

выполнять заказы клиентов

обновлять информацию о книгах при ее изменении в базе данных.
3
Software Design Description
Книжный магазин
Дата:
12/24/2007
2. Запуск приложения
Для того чтобы запустить приложения требуется запустить файл run.bat в результате чего на
экране должно появится следующее окно.
4
Software Design Description
Книжный магазин
Дата:
12/24/2007
3. Работа клиент приложения
Для доступа к базе данных книжного магазина необходимо запустить клиентское приложение.
3.1.
About
Рисунок 1
Данная форма предназначена для отображения данных о программе, о её назначении и о
разработчиках системы. К данной форме все пользователи системы имеют доступ без каких-либо
ограничений.
Отображаются такие поля, как название системы, краткое описание системы, версия продукта,
разработчики и адрес сайта проекта.
При нажатии на кнопку Close данная форма закрывается.
3.2.
Login
Рисунок 2
Данная форма предназначена для авторизации пользователей в системе. Авторизация происходит
по паре почтовый ящик и пароль. Данные подход может помочь в случаях восстановления
паролей по требования пользователей.
5
Software Design Description
Книжный магазин
Дата:
12/24/2007
Так как только зарегистрированные пользователи могут оформлять заказ на книги, то необходимо
иметь на этой форме кнопку, которая бы позволила незарегистрированным пользователем перейти
непосредственно к регистрации в системе.
Содержит два текстовых поля:
1.
имя пользователя;
2.
пароль
И две кнопки кнопку: одна из которых отправляет введённые данные на сервер для авторизации
пользователя, вторая же возвращает пользователя в основное приложение.
3.3.
Signup
Рисунок 3
Данная форма предназначена для регистрации пользователей в системе. При этом пользователям
необходимо ввести свои данные, как например, имя и фамилия.
Для дополнительной защиты требуется предусмотреть поле «подтверждение пароля» в случае
если пользователь случайно ошибётся в его наборе. Ошибиться можно из-за того, что все символы
в данном поле отображаются звёздочками.
Содержит пять текстовых полей:
1.
почтовый адрес;
2.
имя пользователя;
3.
фамилия пользователя;
4.
пароль;
5.
подтверждения пароля.
6
Software Design Description
Книжный магазин
Дата:
12/24/2007
И две кнопки кнопку: одна из которых отправляет введённые данные на сервер для регистрации
пользователя, вторая же возвращает пользователя в основное приложение.
3.4.
Manage Account
Рисунок 4
Форма управления аккаунтом позволяет зарегистрированному пользователю изменить свои
данные. Это может потребоваться в связи с тем, что при регистрации пользователь может неверно
ввести такие поля, как фамилия или имя.
Содержит пять текстовых полей:
1. почтовый адрес;
2. имя пользователя;
3. фамилия пользователя;
4. пароль;
5. подтверждения пароля.
И две кнопки кнопку: одна из которых отправляет введённые данные на сервер для изменения
данных пользователя, вторая же возвращает пользователя в основное приложение.
Лишь зарегистрированные пользователи имеют доступ к этой форме.
3.5.
Book List
Рисунок 5
7
Software Design Description
Книжный магазин
Дата:
12/24/2007
Форма просмотра списка книг отображет список всех доступных в магазине книг. Дополнительно,
при выборе какой-либо книги пользователь может посмотреть её подробную информацию:
«автор», «издатель», «цена», «количество доступных книг в магазине». Это происходит
обновлением значением полей, которые расположены в нижней части формы.
Форма имеет кнопки добавления книг в корзину пользователя и просмотра пользовательской
корзины при нажатии на которые книга добавляется в корзину пользователя с уведомлением о
том, что книга была добавлена успешно или же возникла ошибки и переход на форму просмотра
корзины соответственно.
Лишь зарегистрированные пользователи имеют доступ к этой форме.
При работе администратора с этой формой доступными становятся следующие элементы:
«изменить книгу», «добавить книгу», «удалить книгу».
При нажатии на кнопку «изменить книгу» следующие поля становятся доступными для
редактирования:
1.
название книги;
2.
автор книги;
3.
издатель книги;
4.
цена книги;
5.
количество книг в магазине.
Данная форма состоит из:
1.
Список названий книг, при выборе которого выводится подробная информация
8
Software Design Description
Книжный магазин
Дата:
12/24/2007
2.
Подробная информация о книге состоит из следующих полей:
a. Название;
b. Автор;
c. Издатель;
d. Цена;
e. Количество.
3.
Кнопка добавления книги в корзину;
4.
Кнопка просмотра корзины;
5.
Кнопки, которые доступны лишь для администратора:
a. Начать изменение книг;
b. Сохранить изменённую книгу;
c. Добавить новую книгу;
d. Удалить книгу.
6.
3.6.
Кнопка закрытия формы.
Cart
Рисунок 6
9
Software Design Description
Книжный магазин
Дата:
12/24/2007
Корзина позволяет посмотреть пользователю список книг, которые он предварительно отобрал
для заказа. Однако добавление в корзину ещё не означает заказ, для этого пользователю надо его
подтвердить, для чего на форме должна быть соответствующая кнопка.
Пользователь должен иметь возможность удалять книги из корзины, получать по ним подробную
информацию. Дополнительно пользователю должна быть предоставлена информация об общей
стоимости заказа и количестве заказанных книг.
При нажатии на кнопку «заказать» системе передаёт соответствующий запрос на сервер и выдаёт
сообщение об ошибке если какую-нибудь книгу невозможно заказать.
Только зарегистрированные пользователи имеют доступ к этой системе.
Данная форма состоит из следующих компонентов:
1.
Список выбранных пользователем книг при выборе которой отображается подробная
информация;
2.
Подробная информация о книге состоит из следующих полей:
a. Название;
b. Автор;
c. Издатель;
d. Цена;
10
Software Design Description
Книжный магазин
Дата:
12/24/2007
e. Количество.
3.
Статистика текущего заказа:
a. Количество заказанных книг;
b. Общая цена заказа.
4.
Кнопки удалить книгу из корзины;
5.
Кнопки подтвердить заказ;
6.
Кнопки закрывающей данную форму.
3.7.
Add Book
Рисунок 7
Форма добавления новой книги в базу данных магазина. Позволяет ввести о книге следующую
информацию: «название», «автор», «издатель», «цена», «количество книг в магазине».
Только администратор имеет доступ к этой форме.
Данная форма состоит из следующих текстовых полей:
1.
Название книги;
2.
Автор книги;
3.
Издатель книги;
4.
Цена книги;
5.
Количество книг в магазине.
6.
Кнопки сохранения введённой книги;
11
Software Design Description
Книжный магазин
Дата:
12/24/2007
7.
3.8.
Кнопки закрывающей данную форму.
User List
Рисунок 8
Форма администрирования пользователей, зарегистрированных в системе. Позволяет посмотреть
список зарегистрированных пользователей в системе, получить по них подробную информацию.
Кроме этого данная форма позволяет изменять данные пользователей, создавать новых
пользователей и изменять роль: «администратор» или «покупатель».
Данная форма содержит:
1.
Список зарегистрированных пользователей данной системы, выбор какого-либо
пользователя позволяет увидеть подробную информацию о пользователе.
2.
Подробная информация о пользователе состоит из следующих полей:
3.
a.
Адрес электронной почты пользователя;
b.
Имя пользователя;
c.
Фамилия пользователя;
d.
Пароль пользователя;
e.
Полем выбора: является ли данный пользователей администратором.
Кнопки создать нового пользователя;
12
Software Design Description
Книжный магазин
Дата:
12/24/2007
4.
Кнопки удалить выбранного пользователя;
5.
Кнопки начать/закончить редактирование пользователей;
6.
Кнопки сохранить изменённого пользователя.
7.
Кнопки закрывающей данную форму.
3.9.
Application
Рисунок 9
Форма, которая объединяет все выше описанные формы и служит для них контейнером.
Состоит из следующего навигационного меню:
1.
2.
System
a.
Login: открывает окно авторизации
b.
Signup: открывает окно новой регистрации
c.
Exit: выходит из программы
Settings
a.
Manage Account: открывает окно изменения аккаунта
13
Software Design Description
Книжный магазин
Дата:
12/24/2007
b.
3.
4.
User List: открывает окно со списком пользователей
Shop
a.
Book List: открывает окно со списком книг
b.
Your Cart: открывает окно с корзиной
c.
Order Books: подтверждает заказ
Help
a.
About: открывает окно «О программе»
14
Software Design Description
Книжный магазин
Дата:
12/24/2007
4. Работа сервер-приложения
Рисунок 9. Консоль запущенного сервера
15
Software Design Description
Книжный магазин
Дата:
12/24/2007
5. Сообщения клиент-приложения
Сообщкние
Результат
Действие
Книга была успешно
сохранена
Нажать кнопку OK и
продолжить работу
Книга была успешно
добавлена в корзину
Нажать кнопку OK и
продолжить работу
Заказ был оформлен
Нажать кнопку OK и
продолжить работу
16