Skip to content

Latest commit

 

History

History
317 lines (302 loc) · 37.4 KB

docs.md

File metadata and controls

317 lines (302 loc) · 37.4 KB

Документация

Содержание

  1. ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММНОМ СРЕДСТВЕ
    1. Основное функциональное назначение программного средства
    2. Полное наименование программного средства
    3. Условное обозначение программного средства
  2. ПОЯСНИТЕЛЬНАЯ ЗАПИСКА К ПРОГРАММНОМУ ПРОДУКТУ
    1. Декомпозиция поставленной задачи
    2. Общая архитектура программного средства
    3. Разработка алгоритма решения задачи
    4. Реализация функционального назначения программного средства
    5. Структурная организация данных
    6. Разработка интерфейса ПС
    7. Описание структуры выходной информации
  3. РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ
    1. Назначение программного средства
    2. Условия выполнения программного средства
    3. Эксплуатация программного средства
    4. Сообщения пользователю

1 ОБЩИЕ СВЕДЕНИЯ О ПРОГРАММНОМ СРЕДСТВЕ

1.1 Основное функциональное назначение программного средства

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

1.2 Полное наименование программного средства

Разработка интегрированного программного модуля «Компания Вояж».

1.3 Условное обозначение программного средства

«Voyage 1.0»

2 ПОЯСНИТЕЛЬНАЯ ЗАПИСКА К ПРОГРАММНОМУ ПРОДУКТУ

2.1 Декомпозиция поставленной задачи

Для достижения цели работы была поставлена следующая задача:

1)Создать модуль “touristCompany” отвечающий за сохранение БД. Результат работы модуля - сохранение БД.

Поставленные задачи наглядно отображаются на диаграмме деятельности.

Декомпозиция поставленной задачи

Рис.1 Декомпозиция поставленной задачи


2.2 Общая архитектура программного средства

Объектом моделирования является туристическая компания «Вояж».

Рассматриваемые процессы: работа личными данными клиентов и представителей компании, организация групп, маршрутов, а также его пунктов.

Объекты моделирования представлены на диаграмме классов, рис.2.

Диаграмма классов

Рис.2 Диаграмма классов


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

Схема событийно-ориентированной архитектуры

Рис.3 Схема событийно-ориентированной архитектуры


В «Voyage 1.0» используется событийно-ориентированная архитектура.(Рис.4) Роль агента (источник событий) в программе выполняют: рабочий персонал компании, за роль стоков (потребители событий) отвечают таблицы, входящие в базу данных. Например, когда работник компании выбирает определенное действие: добавить, удалить, редактировать, вывести отчет и т.д. система осуществит выбранные действия, и база отреагирует соответствующим образом: запись добавлена, удалена, отредактирована, либо был сформирован отчет.

Диаграмма вариантов использования

Рис.4 Диаграмма вариантов использования


2.3 Разработка алгоритма решения задачи

Общий алгоритм

Алгоритм программы

Рис.5 Алгоритм программы


2.4 Реализация функционального назначения программного средства

Программа «Voyage 1.0» имеет следующий набор входных данных, такие как: личные данные клиентов, личные данные представителей компании, информация о маршрутах и его пунтках, а также данные о группах.

Данные вводятся пользователем в соответсвующие поля ввода.

Выходными данными являются: списки клиентов, маршрутов, групп, представителей компании и пунктов маршрутов.

Данные выводятся пользователем в соответсвующие поля вывода.

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

2.5 Структурная организация данных

Для создания БД необходимо определиться с данными, которые необходимы для полноценного функционирования системы. Все эти данные указаны в реляционной модели инегрированного программного модуля «Компания Вояж» представленная на рисунке. Любая реляционная база данных и называется реляционной, что характеризуется отношениями (relation) между таблицами. На рисунке изображены основные таблицы моей базы данных. При этом одна таблица является родительской (главной), а вторая – дочерней (подчиненной). Главной таблицей является «tGroups». Реляционная модель автоматизированной системы соответствует всем 12 правилам Кодда. (рис.6)

Реляционная модель

Рис.6 Реляционная модель


Первичный ключ в базе уникален, используется для организации отношений между таблицами, который не может иметь пустых и повторяющихся значений. Во всей базе множество первичных ключей: ID_User (tUser), ID_Group (tGroups), ID_GroupsClients (tGroupsClients), ID_Client (tClients), ID_GroupsRoutes (tGroupsRoutes), ID_Route (tRoutes), ID_Worker (tWorkers), ID_RoutesPuncts (tRoutesPuncts), ID_Punct (tPuncts). Остальные ID-ключи являются внешними ключами.

Для организации более эффективной обработки данных применяется нормализация. Таблицы моей БД находятся в 3НФ:

  • БД находится в форме -1НФ потому, что
    • Таблица не имеет повторяющихся записей;
    • Каждый атрибут отношения хранит одно-единственное значение и не является списком, ни множеством значений;
    • Таблица не имеет повторяющихся групп полей.
  • Вторая нормальная форма(2НФ):
    • Устранены атрибуты, зависящие только от части уникального (первичного) идентификатора, т.е. ID.
  • Третья нормальная форма(3НФ):
    • Отсутствуют атрибуты, зависящие от атрибутов, не входящих в уникальный (первичный) ключ.

На основе реляционной модели базы данных мною в Microsoft SQL Server Management Studio 17 была построена следующая база данных. (Рис.7) В ней первичным ключом является поле таблицы “tGroups” – “ID_Group”. Связь таблиц “tGroups” и “tGroupsClients” по полю “ID_Group” один ко многим (1:М). Таблицы “tClients” и “tGroupsClients” связаны по полю “ID_ Clients” типом связи один ко многим (1:М). Таблицы “tGroups” и “tGroupsRoutes” связаны по полю “ID_Group ” типом связи один ко многим (1:М). Таблицы “tRoutes” и “tGroupsRoutes” связаны по полю “ID_Route” типом связи один ко многим (1:М). Таблицы “ tWorkers” и “ tRoutes ” связаны по полю “ID_Worker” типом связи один ко многим (1:М). Таблицы “tRoutes” и “tRoutesPuncts” связаны по полю “ID_Route” типом связи один ко многим (1:М). Таблицы “tPuncts” и “tRoutesPuncts” связаны по полю “ID_Punct” типом связи один ко многим (1:М). Все связи между таблицами базы данных типа один ко многим.

Схема базы данных

Рис.7 Схема базы данных


Таблица “tClients”(Клиенты)

Таблица tClients

Рис.8 Таблица tClients


Таблица “tGroupsClients”

Таблица tGroupsClients

Рис.9 Таблица tGroupsClients


Таблица “tGroups”(Группы)

Таблица tGroups

Рис.10 Таблица tGroups


Таблица “tGroupsRoutes”

Таблица tGroupsRoutes

Рис.11 Таблица tGroupsRoutes


Таблица “tRoutes” (Маршруты)

Таблица tRoutes

Рис.12 Таблица tRoutes


Таблица “tRoutesPuncts”

Таблица tRoutesPuncts

Рис.13 Таблица tRoutesPuncts


Таблица “tPuncts”(Пункты маршрутов)

Таблица tPuncts

Рис.14 Таблица tPuncts


Таблица “tWorkers”(Представители компании)

Таблица tWorkers

Рис.15 Таблица tWorkers


Таблица “tUser”(Пользователи)

Таблица tUser

Рис.16 Таблица tUser


2.6 Разработка интерфейса ПС

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

После запуска программы пользователю необходимо ввести свой логин и пароль, чтобы в дальнейшем приступить к работе с главной формой программы, на которой и будут отображаться все события в базе данных. «Voyage 1.0» обладает удобным и интуитивно понятным интерфейсом, так что даже неопытному в обращении с пользовательскими компьютерными программами пользователю не составит труда быстро привыкнуть к работе с данным программным средством.

На рабочем экране расположены несколько кнопок для перехода по вкладкам, предназначенные для комфортной работы с ПО.

Форма Авторизация. С нее осуществляется вызов главной формы приложения. Для того, чтобы продолжить работу с программой необходимо ввести свой логин и пароль, и нажать на кнопку «Войти». (Рис.17)

Окно Авторизация

Рис.17 Окно Авторизация


Форма Главное меню. Интерфейс данной формы состоит из множества компонентов: panel – применяются для бокового меню и для перемещения белого ползунка (тем самым, показывая на какой вкладке находится пользователь), а также для приятного и минималистичного оформления интерфейса; label – отображется информация об авторизированном пользователе, отображется статический текст информационного характера; button – используются для перехода по вкладкам, свертывания/развернтывания бокового меню, закрытия формы. (Рис.18)

Окно Главное меню

Рис.18 Окно Главное меню


Пользовательский элемент управления Главная. Интерфейс данной формы состоит из компонентов: label – отображают статический текст информационного характера; panel – используются для визуального офромления формы. (Рис.19)

Окно Главная

Рис.19 Окно Главная


Пользовательский элемент управления Клиенты. Интерфейс данной формы состоит из компонентов: label – отображают статический текст; textbox – отображают записи из таблицы Клиенты, либо используются для ввода информации, также используются для поиска необходимой записи по определенным критериям; combobox, datetimepicker, checkbox – отображают записи из таблицы Клиенты, либо используются для ввода информации; picturebox – отображет фото каждого из клиентов; datagridview – отображает таблицу с данными о клиентах; а также ряд кнопок для добавления, удаления, сохранения, вывода в Excel информации, скрытия/показа поисковой панели. (Рис.20)

Окно Клиенты

Рис.20 Окно Клиенты


Пользовательский элемент управления Маршруты. Интерфейс данной формы состоит из компонентов: label – отображают статический текст; textbox – отображают записи из таблицы , либо используются для ввода информации, также используются для поиска необходимой записи по определенным критериям; combobox, datetimepicker – отображают записи из таблицы, либо используются для ввода информации; datagridview – отображает таблицу с данными о маршрутах; а также ряд кнопок для добавления, удаления, сохранения, вывода в Excel информации или скрытия/показа поисковой панели. (Рис.21)

Окно Маршруты

Рис.21 Окно Маршруты


Пользовательский элемент управления Группы. Интерфейс данной формы состоит из компонентов: datagridview – отображает таблицу с данными о группах; а также ряд кнопок для добавления, удаления, редактирования, сохранения, вывода в Excel. (Рис.22)

Окно Группы

Рис.22 Окно Группы


Пользовательский элемент управления Представители компании. Интерфейс данной формы состоит из компонентов: label – отображают статический текст; textbox – отображают записи из таблицы Представители компании, либо используются для ввода информации, также используются для поиска необходимой записи по определенным критериям; combobox, datetimepicker, checkbox – отображают записи из таблицы Представители компании, либо используются для ввода информации; picturebox – отображет фото каждого из представителей; datagridview – отображает таблицу с данными о представителях; а также ряд кнопок для добавления, удаления, сохранения, вывода в Excel информации, скрытия/показа поисковой панели. (Рис.23)

Окно Представители компании

Рис.23 Окно Представители компании


Пользовательский элемент управления Пункт маршрута. Интерфейс данной формы состоит из компонентов: label – отображают статический текст; textbox – отображают записи из таблицы Пункт маршрута, либо используются для ввода информации, также используются для поиска необходимой записи по определенным критериям; combobox, datetimepicker – отображают записи из таблицы Представители компании, либо используются для ввода информации; picturebox – отображет фото каждого из представителей; datagridview – отображает таблицу с данными о пунктах определенного маршрута; а также ряд кнопок для добавления, удаления, сохранения, вывода в Excel информации, скрытия/показа поисковой панели. (Рис.24)

Окно Пункт маршрута

Рис.24 Окно Пункт маршрута


2.7 Описание структуры выходной информации

Выходными данными являются: результаты поиска информации личных данных о клиентах и представителях компании, маршрутах и его пукнтах, а также группах. Информация может быть вывдена в отчет в формате документов «Microsoft Excel»

Отчет «Список клиентов»

Рис.25 Отчет «Список клиентов»


Отчет «Список маршрутов»

Рис.26 Отчет «Список маршрутов»


Отчет «Список групп»

Рис.27 Отчет «Список групп»


Отчет «Список пердставителей компании»

Рис.28 Отчет «Список пердставителей компании»


Отчет «Пункты маршрутов»

Рис.29 Отчет «Пункты маршрутов»


3 РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ

3.1 Назначение программного средства

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

3.2 Условия выполнения программного средства

Условия, при соблюдении которых возможно выполнение работы с программным продуктом:

  • Компьютер с установленной на нём «Voyage 1.0».

3.3 Эксплуатация программного средства

Этот раздел содержит обзор приложения «Voyage 1.0» и его основных параметров.

Вводные сведения об интерфейсе пользователя

Первое, что появляется при запуске программы – окно авторизации. С нее осуществляется вызов главной формы приложения. Для того, чтобы продолжить работу с программой необходимо ввести свой логин и пароль, и нажать на кнопку «Войти», в противном случае работа с программой будет невозможна. (Рис.30)

Окно Авторизация

Рис.30 Окно Авторизация


В главном окне программы расположено боковое меню, которое является навигационнцм и, в котором находятся 6 кнопок, предназначенных для перехода по основным вкладкам приложения. Изначально подгружается пользовательский элемент управления «Главная». Пользователь выбирает нужную кнопку и открывается интересующая его вкладка (пользовательский элемент управления). (Рис.31)

Окно Главное меню

Рис.31 Окно Главное меню


Ниже описаны пункты меню управления и информации.

«Главная»: это окно носит исключительно информационные данные о компании. (Рис.32)

Окно Главная

Рис.32 Окно Главная


«Клиенты»: содержит личные данные о клиентах, которые воспользовались услугами компании «Вояж». Здесь можно добавить, изменить, удалить запись, сохранить данные, вывести информацию в файл Excel, а также найти необходимую пользователю запись (воспользовавшись поисковой панелью). (Рис.33)

Окно Клиенты

Рис.33 Окно Клиенты


«Маршруты»: выводит информацию о маршрутах. Здесь можно добавить, изменить, удалить запись, сохранить данные, вывести информацию в файл Excel, а также найти необходимую пользователю запись (воспользовавшись поисковой панелью). Также пользователь может добавить/удалить пункты определенного маршрута. (Рис.34)

Окно Маршруты

Рис.34 Окно Маршруты


«Группы»: вывод полной информации о имющихся группах. Здесь можно создать, изменить или удалить группу, добавить/удалить клиентов, вывести информацию в файл Excel. (Рис.35)

Окно Группы

Рис.35 Окно Группы


«Представители»: содержит личные данные о представителях компании. Здесь можно добавить, изменить, удалить запись, сохранить данные, вывести информацию в файл Excel, а также найти необходимую пользователю запись (воспользовавшись поисковой панелью). (Рис.36)

Окно Представители

Рис.36 Окно Представители


«Пункт маршрута»: выводит информацию о пунктах маршрутов. Здесь можно добавить, изменить, удалить запись, сохранить данные, вывести информацию в файл Excel, а также найти необходимую пользователю запись (воспользовавшись поисковой панелью). (Рис.37)

Окно Пункт маршрута

Рис.37 Окно Пункт маршрута


Работа с Voyage 1.0

После запуска программы вы перейдете на форму авторизации программы. После того как вы ведете корректный логин и пароль, будет произведен переход на главную форму программы. В пользовательских элементах управления «Клиенты», «Маршруты», «Группы», «Представители компании», «Пункт маршрута» заполняем все необходимые для работы пункты. После этого кликаем по кнопке «Добавить запись».

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

После того, как Вы закончите сеанс работы с программой, если Вы хотите выйти из Voyage 1.0 кликните на соответствующей кнопке «Выход».

Основные кнопки Voyage 1.0

Кнопки «Добавить запись», «Удалить запись», «Сохранить», «Вывод в Excel»

Добавить запись
,
Прежде чем добавить запись в таблицу необходимо нажать на данную кнопку. Поля формы будут очищенны, пользователю требуется ввести необходимые данные. Если пользователь нажмет кнопку «Сохранить данные», то введенная информация добавится в БД. Если нажать кнопоку «Отменить», то введенная информация пользователем удалится.
Удалить запись/отменить
,
Кнопка «Удалить запись» позволяет отменить действия при вводе, либо удаляет конкретную запись.
Сохранить данные/обновить запись
Кнопка «Сохранить данные» добавляет запись введенную пользователем в БД, либо обновляет существующую.
Вывод в Excel
,
Кнопка «Вывод в Excel» позволяет вывести информацию в файл Excel.
Поиск
, ,
«Поиск» позволяет найти нужную информацию.
Выход
«Выход» позволяет закрыть необходимую форму.

3.4 Сообщения пользователю

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