УТВЕРЖДЕН 123.45678913.11015-01 13 01-ЛУ Описание программы Проектирование виртуальной библиотеки Подпись и дата 123.45678913.11015-01 13 01 Подпись и дата Взам. инв. № Инв. № дубл. Листов 13 Инв. № подл. 2023 technicaldocs.ru 2 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 АННОТАЦИЯ 3 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 СОДЕРЖАНИЕ 1. Общие сведения ............................................................................................................. 4 1.1. Обозначение и наименование программы ......................................................... 4 1.2. Программное обеспечение, необходимое для функционирования программы ............................................................................................................................ 4 1.3. Языки программирования, на которых написана программа.......................... 4 2. Функциональное назначение ...................................................................................... 5 3. Описание логической структуры............................................................................... 6 3.1. Алгоритм программы........................................................................................... 6 3.2. Используемые методы ......................................................................................... 6 3.3. Структура программы с описанием функций составных частей и связи между ними .......................................................................................................................... 7 3.4. Связи программы с другими программами ....................................................... 7 4. Используемые технические средства ........................................................................ 8 5. Вызов и загрузка............................................................................................................ 9 5.1. Способ вызова программы с соответствующего носителя данных ................ 9 5.2. Входные точки в программу ............................................................................... 9 6. Входные данные........................................................................................................... 10 6.1. Характер, организация и предварительная подготовка входных данных .... 10 6.2. Формат, описание и способ кодирования входных данных .......................... 10 7. Выходные данные ....................................................................................................... 11 7.1. Характер и организация выходных данных .................................................... 11 7.2. Формат, описание и способ кодирования выходных данных ....................... 11 Перечень принятых сокращений ................................................................................. 12 4 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 1. ОБЩИЕ СВЕДЕНИЯ 1.1. Обозначение и наименование программы Наименование системы - «Проектирование виртуальной библиотеки». Обозначение программы - «ВБ» 1.2. Программное обеспечение, необходимое для функционирования программы Для стабильного функционирование программы необходимо: MicrosoftInternetExplorer версии 7.0 и выше, MozillaFirefox (версия 3 и выше) или GoogleChrome (версия 3.0 или выше); веб-сервер Apache 1.3.30 и выше PHP 5.5 и выше; СУБД MySQL 4.1 и выше. 1.3. Языки программирования, на которых написана программа Для написания самого приложения используется язык приложения С++, для написания приложения, который включает программную часть, дизайн и интерфейс пользователя использовался Python с библиотекой Kivy. 5 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 2. ФУНКЦИОНАЛЬНОЕ НАЗНАЧЕНИЕ ПО «ВБ» предназначена для электронного чтения литературы в электронном каталоге библиотеки через Интернет. Пользователь имеет возможность скачивать и читать любые книги не выходя из дома. 6 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 3. ОПИСАНИЕ ЛОГИЧЕСКОЙ СТРУКТУРЫ 3.1. Алгоритм программы Алгоритм ПП построен следующим образом: Для пользователей։ 1. Авторизация пользователя 2. Проверка входа в личный профиль 3. Загрузка главной страницы 4. Загрузка меню и вкладок 5. Переход пользователя к нужной ему вкладке 6. Загрузка этой вкладки 7. Демонстрация содержимого вкладки и доступность действий для пользователя. 8. Завершение сеанса. Для администратора: 1. Вход на сайт 2. Загрузка и просмотр всех страниц и вкладок сайта 3. Доступность ко всей информации 4. Добавление / редактирование / удаление книг. 5. Просмотр всей информации о книгах 6. Загрузка страницы с информацией о пользователях 7. Завершение сеанса. 3.2. Используемые методы При разработке ПП использовался метод «Agile Model» (гибкая методология разработки). При тестировании ПО системы использовались методы «белого ящика» и «черного ящика», что помогло на этапах тестирования выявить проблемы при использовании пользователем или администратором ПП. 7 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 3.3. Структура программы с описанием функций составных частей и связи между ними Программа является модульной системой, основная логика которой разделена по компонентам. Каждый компонент внутреннюю Команды имеет интерфейс управления логику оператора проходят и работы. синтаксический анализ, затем вызываются интерфейсные методы компонентов, необходимые для выполнения команды. Ethernet-кадры проходят стандартами сетевых компонентам с проверки протоколов помощью на корректность передачи данных, интерфейсных в соответствии затем методов со передаются компонентов. Внутренняя логика работы компонента может при необходимости использовать интерфейсные методы другого компонента. Связь с аппаратными средствами устройства осуществляется через драйвер аппаратных средств. 3.4. Связи программы с другими программами Программа имеет связь с ОС устройства пользователя для его оповещения. 8 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 4. ИСПОЛЬЗУЕМЫЕ ТЕХНИЧЕСКИЕ СРЕДСТВА Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT и устройствах типа Phone. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа "мышь" – для ПК. Для работы в диалоговом режиме на телефонах используется сенсорный экран дисплея устройства. Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на гибком и/или жестком дисках. Программа работает под управлением ОС устройства пользователя. 9 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 5. ВЫЗОВ И ЗАГРУЗКА 5.1. Способ вызова программы с соответствующего носителя данных Для администратора вызов программы осуществляется с нажатием на иконку приложения. Пользователю для запуска Системы следует в браузере ввести ее адрес и нажать Enter. 5.2. Входные точки в программу После запуска Системы откроется окно авторизации, в необходимо ввести логин пользователя и пароль, нажать кнопку «Войти». котором 10 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 6. ВХОДНЫЕ ДАННЫЕ 6.1. Характер, организация и предварительная подготовка входных данных Входными данными являются персональные данные пользователя. 6.2. Формат, описание и способ кодирования входных данных Администратор вводит։ текстовые – информация о книге (автор, жанр и т.д.) (строка) графические – обложка книги (PDF) документ – книга в формате (.doc) Пользователь вводит: текстовые – личная информации пользователя (ФИО, Возраст и т.д.) (строка) графические – фотография профиля (PDF) 11 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 7. ВЫХОДНЫЕ ДАННЫЕ 7.1. Характер и организация выходных данных Выходные данные постоянны и выводятся согласно запросу администратора. 7.2. Формат, описание и способ кодирования выходных данных Выходными данными являются: выводимая на экран графическая и текстовая информация (результат анализа системы); файлы в одном из графических форматов – изображения и файлов-PDF текстовые файлы – отчеты о скачиваниях и об отзывах книг; документ – книга в формате (.doc) диагностика состояния системы и сообщения обо всех возникших ошибках. 12 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 ПЕРЕЧЕНЬ ПРИНЯТЫХ СОКРАЩЕНИЙ ВБ Виртуальная библиотека ПП Программный Продукт ПК Персональный Компьютер ОС Операционная Система 13 ХХХ.ХХХХХХХХ.ХХХХХ-01 13 01 Лист регистрации изменений Номера листов (страниц) Изм. изменен- замененных ных Всего № Входящий № листов докумен- сопроводит.д Подп. Дата аннули- (страниц) новых та окум. и дата рованных в докум.
