Практическая работа №24 —
25
Составление руководства пользователя
ИС
Цель работы:
Ознакомиться с процедурой разработки руководства пользователя на создание программного
продукта (ПП) с применением РД 50-34-698-90 «Автоматизированные системы
требования к содержанию документов»
Основные теоретические
сведения
Формальные
требования к документации программного обеспечения описаны в ЕСПД (Единая
система программной документации), неформально: состав документации к
программному обеспечению состоит из описания его внешнего эффекта и описания
его внутреннего устройства.
Первая часть
документации, так называемая «Инструкция пользователю» или «Руководство
пользователю» предназначена для того, кто собирается использовать программное
обеспечение (для пользователя), не вникая в подробности его внутреннего
устройства.
Вторая часть —
«Руководство программисту» необходима при модификации программного обеспечения
или при необходимости исправить в нем ошибку.
В целом,
документация к программному обеспечению может содержать ниже перечисленные
сведения:
1.Наименование
ПО и описание задачи, которую оно решает.
2.Область
применимости ПО.
3.Режим работы
ПО, сообщения, выдаваемые по ходу его работы, ответы пользователя на них (если
это необходимо).
4.Исходные
данные, необходимые для работы ПО; а также выдаваемые им результаты;.
5.Правила
подготовки исходных данных на внешних носителях (если они применяются) и вид
выдаваемой информации.
6.Описание
структуры данных. Для любой переменной описывается ее назначение, атрибуты
(тип, размер массива и т.д.), структура информации в ней, если она не очевидна.
Описание переменных должно начинаться с тех, которые служат исходными данными и
результатами.
7.Описания
форм, объектов. Опись свойств форм и объектов.
8.Тексты
программ, процедур (в виде распечатки ЭВМ) с комментариями.
9.Тесты.
10.Инструкция
(руководство) пользователю.
Инструкция по
использованию программы (или просто «Инструкция пользователю», или «Руководство
для пользователя») — это выдержка из полной документации, предназначенная для
эксплуатации программы. Она представляет собой независимый документ для
пользователя программы, в котором описывается: что делает программа и как им
пользоваться.
«Инструкция
пользователю» должна содержать всю необходимую для пользователя информацию и
должна быть ему понятна без дополнительных материалов (без обращения к другим
спецификациям). Следовательно, необходимая для этой инструкции информация
переписывается полностью из соответствующих спецификаций.
Первая часть
инструкции является описательной и должна содержать:
-наименование
программы;
-краткое
описание программы;
-перечень
выполняемых программой функций;
-краткую
характеристику метода (или методов) решения поставленной задачи, его достоинство
и недостатки;
-полную
библиографическую ссылку на полное описание метода;
-описание
входных и выходных данных.
-описание
структуры базы данных (если она имеется), всех ее таблиц в словесной
(вербальном) форме.
Вторая часть
документа должна описывать порядок работы с программой. Она должна содержать
описание всех режимов работы программы, а также содержание всех печатей и
диагностических сообщений, которые выдаются по ходу выполнения программы.
Следует
помнить, что пользователь по своей квалификации не является программистом и
поэтому его работа с программой описывается на понятном ему языке и достаточно
подробно, а именно:
-как запустить
программу;
-как продолжить
работу с программой (описывается подробный интерактивный режим работы
пользователя с программой);
-подготовка и
ввод исходных данных в программу;
-как
реагировать на запросы программы;
-как вести
работу в исключительных ситуациях;
-как
реагировать на ошибки;
-как
восстановить работу программы в случае аварийного его завершения;
-как получить
требуемый результат;
-как правильно
закончить работу с программой (запланированный программой выход);
-другие
сведения, необходимые пользователю программы.
Задания для выполнения
1.Во
время выполнения лабораторной работы необходимо составить документ «Руководство
пользователю» к разработанной ранее программе.
2.Работа
должна быть оформлена в виде документа «Руководство пользователя» согласно РД
50-34-698-90 «Автоматизированные системы требования к содержанию документов».
3.
Сдать и защитить работу.
Подборка по базе: Правоведение, лабораторная работа.docx, физика Лабораторная работа Ускорение свободного падения.docx, Методическая разработка.docx, Курсовая Разработка лабораторного усилителя постоянного тока на , Методическая разработка урока по литературе.docx, Увлекательная математика (методическая разработка по математике , Практическая работа_ разработка технологической карты урока исто, Физика Лабораторная работа 1.docx, №11 Лабораторная работа ОТС (1).docx, Методическая разработка по химии внеклассного мероприятия.docx
| АВТОНОМНАЯ НЕКОММЕРЧЕСКАЯ ПРОФЕССИОНАЛЬНАЯ ОБРАЗОВАТЕЛЬНАЯ ОРГАНИЗАЦИЯ | |
| «КОЛЛЕДЖ ВОРОНЕЖСКОГО ИНСТИТУТА ВЫСОКИХ ТЕХНОЛОГИЙ» | |
| Специальность: 38.02.03 Программирование в компьютерных системах | |
| Форма обучения: очная | |
| Лабораторная работа №2 | |
| На тему: Разработка руководства пользователя | |
| Документирование и сертификация | |
| (наименование дисциплины, модуля, междисциплинарного курса) | |
| Выполнил (а) | А.Д Поляков |
| подпись инициалы, фамилия | |
| Группа | ПКС-019 |
| Руководитель | М.А Платонова |
| подпись инициалы, фамилия | |
| Воронеж 2022 |
Цель работы: разработать руководство пользователя в соответствии со стандартами, примерами и шаблоном.
Ход работы:
Назначение системы
Работа выполняется в рамках проекта «Автоматизированная система программного управления и взаимодействия с личными делами студентов и электронной документации».
ИС предназначается для введения в эксплуатацию на предприятие учебных заведений, колледжей, СПО для эффективного управления и поиска документов личных дел каждого студента; для осуществления просмотра и поиска личных дел, их изменения и отправки, предоставления сторонним организациям и сотрудникам.
Цели программного модуля управления личными делами студентов состоят в получении сведений о студентах для использования сотрудниками деканата, профкомов и отделов кадров сторонних организаций, при разрешении от учебной организации и владельцев личных дел.
Программное изделие предназначено для использования на стационарном ПК, установленным в специальном помещении с соблюдением норм техники безопасности при работе с электронно-вычислительной техникой.
Разрабатываемое ПО имеет следующие задачи:
- эффективное хранение и предоставление необходимых данных и документов связанных с личными делами студентов;
- управление и осуществление доступа к данным личных дел соответственно уровню доступа для пользователя и сотрудника организации;
- визуализацию и представление хранимых данных;
- сортировку и эргономичный доступ к данным;
- вход в систему управления личными делами студентов с помощью личного идентификатора (логина) и пароля.
Условия применения системы
1. Требования к аппаратному обеспечению
Программа должна быть совместима для работы на платформах с Windows NT и выше (Linux версия ядра 3.x и выше).
ИС использует для реализации программной части язык программирования C#, используя инструментарий интегрированной среды разработки MS Visual Studio. Для редактирования кода и текстовых данных рекомендуется использовать открытый редактор текста Notepad++. Для взаимодействия – создания баз данных используется СУБД PostgreeSQL или MS SQL Server. Система контроля версий Git или Github.
Для защиты данных используется система доступа к данных SecuredSearch, которая организует интерфейс отдачи и приема прав от администрации к пользователям. Копии программы обеспечиваются электронными подписями.
Предусмотрено ежемесячное обслуживание серверов и стационарных ПК в составе ИС для выявления неисправностей и профилактики.
Температура окружающего воздуха не выше 30-40 градусов по Цельсию. Относительная влажность не более 30-40%, повышение данных показателей выше установленных величин может повлиять на нормальное функционирование технической части ИС.
Для разрабатываемых и дорабатываемых подсистем в рамках обеспечения работы устанавливаются следующие количественные значения показателей надёжности:
- режим работы в целом – 7 дней в неделю 24 часа в сутки;
- общее допустимое времени простоя в неделю не должно превышать 30 минут, включая проведение сервисных и регламентных работ при строгом соблюдении регламентных процедур.
2. Требования к квалификации пользователя
Для работы системы должен быть выделен оператор для взаимодействия и управления личными делами, загрузкой и обновления данных в профилях студентов по требованию. Дополнительно – специалисты для распознавания текстов ксерокопий и фотокопий для перевода их в цифровой (текстовый) вид. Требования к составу и параметрам технических средств уточняются на этапе эскизного проектирования системы.
Необходимое количество персонала для качественного и эффективного обслуживания ИС в команде не более 3 человек. Данный персонал должен обладать элементарными знаниями ПК и быть посвящен в IT-сферу.
Техническая часть ИС предполагает наличие офисной техники: принтер, сканер, стационарный телефон; из специализированной техники – серверы для хранения данных личных дел, магнитные ленты для хранения личных дел с увеличенным сроком хранения, ноутбуки или стационарные ПК для использования основных функций программных средств данной ИС.
Подготовка системы к работе
Для запуска ИС «Знай своих» необходимо:
- Открыть программу двойным нажатием на ярлык приложения «СУЛД Знай своих».
- Ввести в появившееся окно аутентификации логин и пароль для входа в ИС.
- После входа в систему выбрать нужного студента для просмотра прикрепленных документов в личное дело.
- При необходимости выбрать в окне приложения нужно действие с данными – прикрепить документы, изменить, удалить, распечатать и поделиться.
- Функции прикрепить и распечатать доступна пользователям, но использование этих функций вызывает окно составления заявки для подтверждения к администрации.
- Функции удалить, изменить и вышеперечисленные доступны администрации без ограничений.
- Для выхода из приложения нужно нажать соответственную кнопку в меню либо закрыть окно приложения.
Описание операций
| Роль «Администратор» | Роль «Пользователь» |
| Возможность изменять документы личных дел студентов. | Возможность просматривать документы и данные в личных делах студентах. |
| Возможность прикреплять (добавлять) новые документы к личным делам. | Возможность составить запрос о распечатки документов из личного дела и сохранения электронной копии. |
| Возможность удалять документы из личных дел. | |
| Возможность просматривать данные в личных делах студентов. |
Аварийные ситуации
При отказе или сбое в работе ИС необходимо:
- Проверить подключение к локальной сети (серверу с базами данных личных дел).
- Перезагрузить приложение.
- Если первые два пункта не дали результату, то необходимо обратиться к действующему системному администратору.
| РД 50-34.698-90 (п.п. 3.4 Руководство пользователя) | ГОСТ 19.505-79 Руководство оператора | ||
| Введение | Данная ИС создавалась в рамках проекта «Автоматизированной обработки личных данных студентов СПО и вузов». | ||
| Область применения | Настоящую ИС предполагается использовать на предприятиях, говоря точнее, в учебных заведениях – частных и государственных. Область применения данной ИС включает в себя все то, что связано с электронной обработкой личных дел студентов. | ||
| Уровень подготовки пользователя | Пользователь не должен иметь специальной подготовки для взаимодействия и работы в данной ИС. Желательно базовые знания в IT-сфере и свободное владение электронной техникой (конкретно – ПК, КПК и проч.) | ||
| Перечень эксплуатационной документации, необходимой для ознакомления пользователем | Необходимая для эксплуатации документация распространяется в электронном виде. Основной документ, который входит в пакет необходимой документации – руководство пользователя ИС «Знай своих». | ||
| Назначение и условия применения | Данная ИС предназначается для обработки личных дел студентов вузов и сузов: изменения, добавления, прикрепления документов в систему управления личных дел. Для применения ИЗ на базе учебных заведений необходимо наличие серверной техники, офисной – сканеры и телефония. Так же необходимо выделенное помещение, в котором работают с настоящей ИС группа из 2-х (максимум 3-х) работников. | ||
| Виды деятельности и функции, для автоматизации которых предназначена программа | ИС предназначена для автоматизации процессов электронной обработки данных личных дел студентов, для удобства распространения и передачи таковых данных. Для взаимодействия между отделами как в самой организации, так и в её пределах. | Назначение программы | Программный продукт предназначается в основном для системного управления личными данными студентов, их распространения и использования в электронном документообороте. |
| Условия, при которых обеспечивается применение программы | Главное условия для применения данной ИС – наличие серверной структуры на предприятии, необходимые работники и доступ к локальной (или доступ к сети Интернет). | Условия выполнения программы | Для выполнения программы главное условие в наличие настроенной топологии серверов и наличие локальной сети. |
| Подготовка к работе | Для подготовки к работе данной ИС требуется настроить локальную сеть, подключить базы данных предприятия к ИС (управление через десктоп или web-форму) и открыть клиент. | Выполнение программы | Основная часть работы программы выполняется пользователем в клиенте системы. Серверная часть и другая доверяется специальному отделу на предприятии. |
| Состав и содержание дистрибутивного носителя данных | Основное содержание распространяемого ПО – ИС «Знай своих» — это клиент для работы с базами данных в учебном заведении; альтернативное управление личными делами через web-форму и лицензионный профиль с логином и паролем. | ||
| Порядок загрузки данных и программ | В начале пользования ИС «Знай своих» нужно авторизовать пользователя или супер-пользователя для организации. После же подключить базы данных к системе управления личных дел. Для завершения работы желательно закрывать только клиент, при закрытия сервера могут возникнуть утечки данных и фатальные ошибки ПО. | Порядок загрузки, запуска и завершения программы | Программа загружается в варианте десктоп версии или портативной версии в web-форме. Запускается сначала серверная часть, а после клиентская. Нормальное завершение программы предполагается автоматическое сохранение данных и выключение клиентской части (серверная часть предназначена для функционирования в режиме 24/7). |
| Проверка работоспособности | Для проверки работоспособности необходимо выбрать соответствующий пункт меню в клиентском приложении ИС «Знай своих». После открытия нужного окна – пройти полный цикл проверки работоспособности по представленному алгоритму. | ||
| Описание операций | Основные операции производимые в ИС «Знай своих»: загрузка данных к личному делу студентов, создания профилей студентов, прикрепление данных к личным делам, удаление данных, распространение электронных копий данных, реализация иерархии доступа и использования ИС на предприятии. | Описание функций | Удаление данных, распространение данных и прикрепленных документов, прикрепление и дополнение личных дел студентов, управление иерархией прав и проч. |
| Описание всех выполняемых функций, задач, комплексов задач и процедур | Основная функция ИС – обработки и передача данных личных дел студентов. Основная задача – эффективный электронный документооборот, рассчитанный на снижение затрат и сил работников на ручную обработку документации. Комплексная задача ИС – это расширяемость и дополнение функционала для эффективной и экономной работы с личными делами. | ||
| Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач и процедур | Основные операции технологического процесса обработки данных состоят во взаимодействии с физическим серверным оборудования путем программного манипулирования данными; использования возможности локальных и глобальной сети для эффективной работы ИС. | ||
| Аварийные ситуации (действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных, и т.п.) | В случае длительных отказов технических средств обратится к системному администратору на предприятии. При обнаружении несанкционированного вмешательства в данные попытаться воспользоваться функцией экстренного копирования данных и закрыть доступ для всех пользователей (объявить технический перерыв); так же стоит обратиться к действующему системному администратору. | Сообщения оператору | Не значатся. |
| Рекомендации по освоению | Не имеется специальных рекомендаций по освоению ИС «Знай своих», кроме уже перечисленных в технических и проч. требованиях к эксплуатации. |
Вопросы для самоконтроля:
1. Какие действия включает раздел «настройка программы»?
Описание действий по настройке программы, настройка на состав технических средств, выбор функций, поясняющие примеры.
2. Какие ГОСТы необходимо знать, чтобы грамотно оформить руководство пользователя?
ГОСТ 19.402-78, ГОСТ 19.502-78, ГОСТ 19.503-79, ГОСТ 19.504-79, ГОСТ 19.505-79, РД 50-34.698-90.
3. Кто является разработчиком руководства пользователя?
Разработчиком руководства пользователя является тот сотрудник, который занимается разработкой и приготовлением сопровождающей документации для приложения (советуясь с тем, кто разрабатывал данный программный продукт).
Вывод: было разработано руководство пользователя в соответствии со стандартами, примерами и шаблонам.
Цель
работы: разработать документацию
для пользователя, разработать справочную
систему для программного продукта.
Постановка
задачи: разработать программный
документ «Руководство пользователя»
для программного продукта «Калькулятор
комплектующих ПК». На основе созданного
документа разработать справочную
систему.
1. Назначение
программы.
Калькулятор
комплектующих ПК – программа,
предназначенная для сборки настольного
компьютера по отдельным комплектующим.
С помощью приложения «Калькулятор
комплектующих ПК» пользователь может
быстро и с экономией бюджета собрать
собственную сборку системного блока.
2. Условия
выполнения программы.
Минимальные
системные требования для успешного
выполнения программного продукта
«Калькулятор комплектующих ПК»:
– операционная
система: Windows XP;
– оперативная
память: 256 Мб;
– процессор: Intel
Celeron с тактовой частотой 233 МГц;
– видеоадаптер: видеокарта
с поддержкой DIRECTX 9;
– свободное
место на жестком диске: 20 Мб.
3. Выполнение
программы.
Для
запуска программы «Калькулятор
комплектующих ПК» нужно дважды нажать
левой кнопкой мыши по исполняемому
файлу «kalkkomppk.exe».
После того, как программа запустилась,
на экране появиться главная форма
программного продукта «Калькулятор
комплектующих ПК», внешний вид которой
представлен на рисунке 3.9.
Рисунок
3.9 – Главная форма программы
«Калькулятор
комплектующих ПК»
На
главной форме программы «Калькулятор
комплектующих ПК» располагаются
следующие элементы: главное меню,
панель быстрых кнопок, вкладки с
комплектующими компьютера, таблицы,
выпадающие списки, список текстовых
полей, текстовые поля с ценами, панель
состояния.
Главное
меню содержит следующие
пункты: «Файл» – «Выход»;
«Действия» – «Фильтр», «Сумма»,
«Вставить в БД»; «Компоненты» –«Процессор»,
«Видеокарта», «Материнская плата»,
«Оперативная память», «Жесткий диск и
SSD»;
«Помощь» – «Справка о программе».
Панель
быстрых кнопок состоит из следующих
кнопок, которые дублируют функции
пунктов главного меню: «Фильтр»,
«Сумма», «Вставить в БД», «Справка о
программе». Внешний вид панели быстрых
кнопок программы «Калькулятор
комплектующих ПК» изображен на рисунке
3.10.
Рисунок
3.10 – Панель быстрых кнопок
Каждая
комплектующая имеет свою вкладку, внутри
которой находится таблица с записями
о комплектующих компьютера. Вкладки с
названиями комплектующих представлены
на рисунке 3.11.
Рисунок
3.11 – Вкладки с комплектующими компьютера
Список
текстовых полей содержит названия
выбранных комплектующих компьютера.
Каждое текстовое поле закреплено за
определенным комплектующим компьютера.
Внешний вид текстовых полей с названиями
комплектующих представлен на рисунке
3.12.
Рисунок
3.12 – Текстовые поля с названиями
комплектующих
Панель
состояния предназначена для отображения
подробного описания того или иного
элемента пользовательского интерфейса
программы. Для того чтобы увидеть
подробное описание элемента интерфейса,
на этот элемент нужно навести указателем
мыши. Панель состояния с подсказкой для
кнопки «Поиск» представлена на рисунке
3.13.
Рисунок
3.13 – Панель состояния с подробными
подсказками
Для
того чтобы выбрать комплектующую и
добавить ее в список, нужно один раз
нажать левой кнопкой мыши на строчку в
таблице с названием определенной
комплектующей. Нажатая строчка выделится
синим цветом так, как показано на рисунке
3.14.
Рисунок
3.14 – Выделение синим цветом выбранной
комплектующей
После
нажатия на запись название выбранной
комплектующей отобразиться в
соответствующем текстовом поле, а справа
от текстового поля с названием появится
цена выбранной комплектующей. Заполненные
текстовые поля с названием и ценой
представлены на рисунке 3.15.
Рисунок
3.15 – Название и цена выбранной
комплектующей компьютера
Для
того чтобы выполнить поиск определенной
комплектующей необходимо в выпадающих
списках выбрать желаемые параметры
так, как показано на рисунке 3.16. В
программе реализована возможность
поиска комплектующих компьютера по
одному или нескольким параметрам.
Рисунок
3.16 – Выбор параметров для поиска из
выпадающих списков
После
того, как выбраны параметры для поиска,
нужно нажать либо на кнопку «Фильтр»,
расположенную на панели быстрых кнопок,
либо нажать сочетание клавиш «Shift+F»,
либо зайти в раздел главного меню
«Действия» и выбрать пункт «Фильтр»
для того, чтобы был выполнен поиск
комплектующей по выбранным параметрам.
Когда
выбраны все комплектующие, то в правом
нижнем углу будет указана итоговая цена
системного блока так, как показано на
рисунке 3.17.
Рисунок
3.17 – Результат работы программы
«Калькулятор
комплектующих ПК»
4. Сообщения
пользователю.
При
работе с программой «Калькулятор
комплектующих ПК» у пользователя могут
возникнуть вопросы по элементам
графического пользовательского
интерфейса. Например, что делает та или
иная кнопка, или, что выводится в то или
иное текстовое поле. Для ответа на эти
вопросы существует строка состояния,
в которую выводятся подробные описания
того или иного элемента графического
пользовательского интерфейса программы.
Для того чтобы увидеть подробное описание
элемента интерфейса программы, на этот
элемент нужно навести указателем мыши.
Также
в программе «Калькулятор комплектующих
ПК» существуют различные всплывающие
диалоговые окна. Ниже приведен список
этих окон:
– диалоговое
окно при выходе из программы;
– диалоговое
окно при добавлении новой записи о
комплектующей компьютера в таблицу
базы данных, которое указывает, что не
все поля заполнены, и запись в таблицу
добавлена не будет;
– диалоговое
окно при удалении записи о комплектующей
компьютера из таблицы базы данных.
Результаты
выполнения лабораторной работы: в
рамках данной лабораторной работы был
разработан программный документ
«Руководство пользователя» для приложения
«Калькулятор комплектующих ПК». В
документе «Руководство пользователя»
были указаны сведения о назначении,
функциональных особенностях и системных
требованиях программы «Калькулятор
комплектующих ПК». Также был описан
порядок работы с программой, было
приведено описание функций и
пользовательского интерфейса. На основе
документа «Руководство пользователя»
в программе HTML
Help Workshop
была создана справочная система для
программного приложения «Калькулятор
комплектующих ПК».
ЗАКЛЮЧЕНИЕ
Выпускная
квалификационная работа была посвящена
разработке учебно-методического
комплекса
по дисциплине «Разработка программных
приложений». Созданный учебно-методический
комплекс имеет удобную структуру и
содержит всю необходимую информацию
для самостоятельного изучения и освоения
дисциплины «Разработка программных
приложений».
В
целях
повышения
качества восприятия методической
информации
учебно-методический
комплекс был
разработан в электронном виде.
Электронный учебно-методический комплекс
представляет собой веб-сайт,
который можно использовать
на любом локальном компьютере без
доступа к интернету.
Все страницы
были
оформлены
с помощью языков HTML
и CSS.
Разработанный
учебно-методический комплекс предназначен
для использования студентами очной
формы обучения, направления 230700.62 –
«Прикладная информатика», профиля
«Прикладная информатика в экономике»,
изучающих дисциплину «Разработка
программных приложений». Методический
комплекс будет оказывать помощь в
изучении и систематизации теоретических
знаний, а также будет формировать
практические навыки работы в предметной
области с использованием современных
информационных технологий.
В
ходе выполнения выпускной квалификационной
работы были выполнены все поставленные
задачи:
1. Разработана
структура учебно-методического комплекса
по дисциплине «Разработка программных
приложений».
2. Разработана
рабочая программа, которая содержит
основные сведения по дисциплине
«Разработка программных приложений».
3. Определены
требования для учебно-методического
материала, а также для электронного
учебно-методического комплекса по
дисциплине «Разработка программных
приложений».
4. Подобраны
программные и инструментальные средства
для создания электронного учебно-методического
комплекса по дисциплине «Разработка
программных приложений».
5. Разработан
макет для электронного учебно-методического
комплекса по дисциплине «Разработка
программных приложений».
6. Сверстан
макет для электронного учебно-методического
комплекса по дисциплине «Разработка
программных приложений».
7. Приведены
результаты проделанной работы, а именно:
– представлены
содержания разделов по дисциплине
«Разработка программных приложений»;
– представлены
содержания лабораторных работ по
дисциплине «Разработка программных
приложений»;
– представлены
веб-страницы электронного учебно-методического
комплекса по дисциплине «Разработка
программных приложений».
Таким
образом, в результате выпускной
квалификационной работы был создан
учебно-методический комплекс по
дисциплине «Разработка программных
приложений», который может быть внедрен
в процесс обучения и успешно использоваться
преподавателями и студентами.
СПИСОК
ЛИТЕРАТУРЫ
1. Рудаков
А.В., Федорова Г.Н. Технология разработки
программных продуктов. Практикум. –
М.: Академия, 2012. – 192 с.
2. Лешек
Мацяшек. Практическая программная
инженерия на основе учебного примера.
– М.: Бином. Лаборатория знаний, 2012. –
956 с.
3. Орлов
С.А. Прогаммная инженерия. Учебник для
вузов. – СПб.: Питер, 2016. – 640 с.
4. Гагарина
Л.Г. Разработка и эксплуатация
автоматизированных информационных
систем. Учебное пособие. – М.: Инфра-М,
2015. – 384 с.
5. Алан
Купер, Роберт Рейман, Дэвид Кронин и
Кристофер Носсел. Интерфейс. Основы
проектирования взаимодействия. – СПб.:
Питер, 2017. – 720 с.
6. Тео
Мандел. Разработка пользовательского
интерфейса. – М.: Книга по Требованию,
2001. – 410 с.
7. Джеф
Раскин.
Интерфейс. Новые направления в
проектировании компьютерных систем. –
СПб.: Символ-Плюс, 2007. – 272 с.
8. Алфимцев
А.Н. 25
упражнений по юзабилити. – Саарбрюккен:
LAP Lambert Academic Publishing, 2014. – 108 с.
9. Макаровских
Т.А. Документирование программного
обеспечения. В помощь техническому
писателю. Учебное пособие. – М.: Ленанд,
2015. – 266 с.
10. Глаголев
В.А. Разработка технической документации.
Руководство для технических писателей
и локализаторов ПО. – СПб.: Питер, 2008. –
192 с.
11. Фленов
М.Е. Библия Delphi.
– СПб.: БХВ-Петербург, 2011. – 688 с.
12. Дарахвелидзе
П.Г., Марков Е.П. Программирование в
Delphi
7. – СПб.:
БХВ-Петербург, 2003. – 784 с.
13. Хоменко
А.Д., Гофман В.Э., Мещеряков Е.В. Delphi
7. – СПб.:
БХВ-Петербург, 2010. – 1136 с.
14. Шкрыль
А.А. Разработка клиент-серверных
приложений в Delphi. – СПб.: БХВ-Петербург,
2006. – 480 с.
15. Кириллов
В.В., Громов Г.Ю. Введение в реляционные
базы данных. – СПб.: БХВ-Петербург, 2009.
– 464 с.
16. Хоменко
А.Д., Гофман В.Э. Работа с базами данных
в Delphi. – СПб.: БХВ-Петербург, 2005. – 640 с.
17. Осипов
Д.Л. Базы данных и Delphi. Теория и практика.
– СПб.: БХВ-Петербург, 2011. – 752 с.
18. Астахова
И.Ф., Мельников В.М., Толстобров А.П.,
Фертиков В.В. СУБД: язык SQL в примерах и
задачах. – М.: Физматлит, 2009. – 168 с.
19. Маркин
А.В. Построение запросов и программирование
на SQL. Учебное пособие. – М.: Диалог-Мифи,
2014. – 384 с.
20. Дунаев
В.В. Базы данных. Язык SQL. – СПб.:
БХВ-Петербург, 2006. – 288 с.
21. Кисленко
Н.П. HTML.
Самое необходимое. – СПб.: БХВ-Петербург,
2008. – 352 с.
22. Петюшкин
А.В. HTML
в
Web-дизайне.
– СПб.: БХВ-Петербург, 2004. – 400 с.
23. Луис
Лазарис. CSS.
Быстрый старт. – М.: Эксмо, 2014. – 192 с.
24. Джон
Дакетт. HTML
и CSS.
Разработка и дизайн веб-сайтов. – М.:
Эксмо, 2013. – 480 с.
25. Захарова
И.Г. Информационные технологии в
образовании. – М.: Академия, 2013. – 192 с.
26. Федеральные
государственные образовательные
стандарты высшего профессионального
образования по направлениям подготовки
бакалавриата. URL: http://fgosvo.ru/fgosvpo/7/6/1
(дата обращения
–
20.03.2017).
27. ГОСТ
Р 55751-2013. Информационно-коммуникационные
технологии в образовании. Электронные
учебно-методические комплексы. Требования
и характеристики. – М.: Стандартинформ,
2014. – 11 с.
28. Шалкина
Т.Н., Запорожко В.В., Рычкова А.А. Электронные
учебно-методические комплексы:
проектирование, дизайн, инструментальные
средства. –
Оренбург: ГОУ
ОГУ,
2008.
– 160
с.
29. Фреймворк
Bootstrap
| ИТ Шеф.
URL: https://itchief.ru/lessons/bootstrap-3
(дата
обращения – 28.03.2017).
30. НОУ
ИНТУИТ | Лекция | Создание
справочной системы.
HTML
Help Workshop.
URL: http://www.intuit.ru/studies/courses/13745/1221/lecture/23323
(дата обращения – 13.05.2017).
приобрести
скачать (37 kb.)
- Смотрите также:
- Trace Mode 6 Руководство пользователя. Том 2 (Документ)
- · Программа VisualRoute (Документ)
- Практическая работа. Создание виртуальной машины и подключение к ней (2 Скриншота: в панели управления вм, экран запущенной вм) Практическая работа. Получаем доступ (Документ)
- Практическая работа №2 Расчет водопотребления и Участок (зона) ежедневного обслуживания (ЕО) автомобилей 4 Моторное отделение 5 (Документ)
- Лабораторная работа №1 ТГУ — Делопроизводство (Лабораторная работа)
- Практические работы по бурению (Лабораторная работа)
- Руководство пользователя.Рабочее место пользователя системы QUIK. Версия 5.24 (Стандарт)
- Лабораторная работа — Анализ эффективности инвестиционного проекта и разработка бизнес-плана в системе Project Expert (Лабораторная работа)
- Практическая работа №8 Название работы: Составление дефектной ведомости (Документ)
- Практическая работа №1 «Составление резюме, автобиографии, характеристики» Оформляем на листах А4 с рамками (Документ)
- Практическая работа №11 Формирование стратегии коммуникаций Составление плана коммуникаций проекта (Документ)
- Руководство пользователя модуля аутентификации mydss настоящий документ содержит руководство пользователя модуля аутентификации (Документ)
Практическая работа №24 — 25
Составление руководства пользователя ИС
Цель работы: Ознакомиться с процедурой разработки руководства пользователя на создание программного продукта (ПП) с применением РД 50-34-698-90 «Автоматизированные системы требования к содержанию документов»
Основные теоретические сведения
Формальные требования к документации программного обеспечения описаны в ЕСПД (Единая система программной документации), неформально: состав документации к программному обеспечению состоит из описания его внешнего эффекта и описания его внутреннего устройства.
Первая часть документации, так называемая «Инструкция пользователю» или «Руководство пользователю» предназначена для того, кто собирается использовать программное обеспечение (для пользователя), не вникая в подробности его внутреннего устройства.
Вторая часть — «Руководство программисту» необходима при модификации программного обеспечения или при необходимости исправить в нем ошибку.
В целом, документация к программному обеспечению может содержать ниже перечисленные сведения:
1.Наименование ПО и описание задачи, которую оно решает.
2.Область применимости ПО.
3.Режим работы ПО, сообщения, выдаваемые по ходу его работы, ответы пользователя на них (если это необходимо).
4.Исходные данные, необходимые для работы ПО; а также выдаваемые им результаты;.
5.Правила подготовки исходных данных на внешних носителях (если они применяются) и вид выдаваемой информации.
6.Описание структуры данных. Для любой переменной описывается ее назначение, атрибуты (тип, размер массива и т.д.), структура информации в ней, если она не очевидна. Описание переменных должно начинаться с тех, которые служат исходными данными и результатами.
7.Описания форм, объектов. Опись свойств форм и объектов.
8.Тексты программ, процедур (в виде распечатки ЭВМ) с комментариями.
9.Тесты.
10.Инструкция (руководство) пользователю.
Инструкция по использованию программы (или просто «Инструкция пользователю», или «Руководство для пользователя») — это выдержка из полной документации, предназначенная для эксплуатации программы. Она представляет собой независимый документ для пользователя программы, в котором описывается: что делает программа и как им пользоваться.
«Инструкция пользователю» должна содержать всю необходимую для пользователя информацию и должна быть ему понятна без дополнительных материалов (без обращения к другим спецификациям). Следовательно, необходимая для этой инструкции информация переписывается полностью из соответствующих спецификаций.
Первая часть инструкции является описательной и должна содержать:
-наименование программы;
-краткое описание программы;
-перечень выполняемых программой функций;
-краткую характеристику метода (или методов) решения поставленной задачи, его достоинство и недостатки;
-полную библиографическую ссылку на полное описание метода;
-описание входных и выходных данных.
-описание структуры базы данных (если она имеется), всех ее таблиц в словесной (вербальном) форме.
Вторая часть документа должна описывать порядок работы с программой. Она должна содержать описание всех режимов работы программы, а также содержание всех печатей и диагностических сообщений, которые выдаются по ходу выполнения программы.
Следует помнить, что пользователь по своей квалификации не является программистом и поэтому его работа с программой описывается на понятном ему языке и достаточно подробно, а именно:
-как запустить программу;
-как продолжить работу с программой (описывается подробный интерактивный режим работы пользователя с программой);
-подготовка и ввод исходных данных в программу;
-как реагировать на запросы программы;
-как вести работу в исключительных ситуациях;
-как реагировать на ошибки;
-как восстановить работу программы в случае аварийного его завершения;
-как получить требуемый результат;
-как правильно закончить работу с программой (запланированный программой выход);
-другие сведения, необходимые пользователю программы.
Задания для выполнения
1.Во время выполнения лабораторной работы необходимо составить документ «Руководство пользователю» к разработанной ранее программе.
2.Работа должна быть оформлена в виде документа «Руководство пользователя» согласно РД 50-34-698-90 «Автоматизированные системы требования к содержанию документов».
3. Сдать и защитить работу.
Практическая работа №24 — 25
16
Московский государственный технический университет им. Н.Э.Баумана
_________________________________________________________________
|
УТВЕРЖДАЮ: |
|
|
Большаков С.А. |
«__»_____________201X Г. |
Комплексная лабораторная работа/ДЗ по дисциплине ПКШ
“Система классов улиц и домов”
Руководство пользователя
(вид документа)
писчая бумага
(вид носителя)
16
(количество листов)
|
ИСПОЛНИТЕЛЬ: |
|
|
студент группы ИУ5-ХХ |
_____________________ |
|
Большаков С.А. |
«__»_____________201X г. |
Москва — 201X
________________________________________________________________
СОДЕРЖАНИЕ
1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ 3
2. ПОДКЛЮЧЕНИЕ СИСТЕМЫ КЛАССОВ И ДИАГРАММА КЛАССОВ 3
3. РАБОТА С СИСТЕМОЙ КЛАССОВ 3
3.1. Общие сведения о системе классов улиц и домов 3
3.2. Диаграмма классов улиц и домов 4
3.3. Подключение системы классов в программу 4
3.4. Общие данные и переменные 5
4. КЛАСС ДОМОВ — Home 5
4.1. Данные и переменные класса Home 5
4.2. Конструкторы класса Home 6
4.3. Деструктор класса Home 7
4.4. Методы класса Home 7
4.5. Операции класса Home 9
4.6. Дружественные функции класса Home 9
5. КЛАСС Улиц — Street 9
5.1. Данные и переменные класса Street 9
5.2. Конструкторы класса Street 10
5.3. Деструктор класса Street 10
5.4. Методы класса Street 11
5.5. Операции класса Street 13
5.6. Дружественные функции класса Home 14
6. ОТКЛЮЧЕНИЕ СИСТЕМЫ КЛАССОВ 15
7. СООБЩЕНИЙ ОБ ОШИБКАХ И ИСКЛЮЧИТЕЛЬНЫЕ СИТУАЦИИ 15
1 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
Система классов домов и улиц предназначена для автоматизации работы с объектами улиц и домов в программных проектах и предметной области, где необходимо это учитывать. В частности, система классов предназначена для программирования задач включающих действия: оценки ремонта домов и улиц, подсчета числа жителей, квартир и этажей в домах. Система классов обеспечивает удобную работу с этими объектами, высокий уровень надежности программ, функциональных возможностей, а также сокращение сроков разработки и реализации программных продуктов, где необходимо использовать подобные объекты.
2 ПОДКЛЮЧЕНИЕ СИСТЕМЫ КЛАССОВ И ДИАГРАММА КЛАССОВ
Для того, чтобы установить данную систему классов на компьютер следует произвести следующие действия:
-
Освободить на жестком диске как минимум 200 килобайт свободного пространства.
-
Вставить дискету или CD/DVD носитель с дистрибутивом программного продукта в дисковод или CD/DVD устройство.
-
Скопировать файлы. С помощью системной функции копирования файлы (или файл менеджера), которые перечислены в разделе 4 этого документа, с носителя на жесткий диск в нужные каталоги. Для испытаний любой доступный каталог (DZ_2kurs.exe). Для подключения в новый проект (DZ.h, DZ_Class.h, DZ_LIB.cpp) в общий каталог заголовочных файлов или в специально созданный каталог для новой сборки тестового примера (DZ_Array.exe , DZ_Array.cpp ,DZ.h, DZ_Class.h, DZ_LIB.cpp).
-
Прописать в установках каталогов для используемой на компьютере системы программирования С++ полный пути к директории, куда был установлены модели системы классов (DZ_Array.cpp ,DZ.h, DZ_Class.h, DZ_LIB.cpp).
3 РАБОТА С СИСТЕМОЙ КЛАССОВ
4 Общие сведения о системе классов улиц и домов
Система классов описывает дома и улицы для разработки программ, в которых учет сведений об этих объектах необходим.
Дом – объекты данного типа содержат информацию о номере дома, этажности, числе жителей и квартир, необходимости ремонта дома и типе дома. Предусматривается возможность изменения параметров дома.
Улица – объекты данного типа в упорядоченном виде содержат информацию о домах улице, названии улицы, типе улицы, соседних улицах (как резерв), необходимости ремонта улицы, числе домов, номера улицы (как резерв). Предусматривается возможность добавления домов на улицу и их удаления, изменения других параметров улицы.
Система классов позволяет программировать следующие операции и функции:
-
Создание и задание свойств объектов типа дом и улица;
-
Установка признака ремонта домов;
-
Сложение двух домов;
-
Получение параметров домов (номера, числа жителей, числа квартир, типа дома);
-
Установки и изменения параметров дома (номера, числа жителей, числа квартир, типа дома);
-
Удаление объектов типа дом и улица;
-
Распечатки свойств объектов типа дом и улица;
-
Добавление домов на конкретную улицу;
-
Удаление дома с конкретной улицы;
-
Сложение двух улиц (при объединении улиц);
-
Переименование улиц и новую нумерацию домов;
-
Распечатки списка домов улицы с их характеристиками;
-
Получение параметров улицы (названия, числа жителей, числа квартир, типа улицы);
-
Установки и изменения параметров улицы (названия, числа жителей, числа квартир, типа улицы);
-
Автоматическое получение признаков необходимости ремонта домов на улице.
5 Диаграмма классов улиц и домов
Ниже приставлена диаграмма классов системы классов улиц и домов программного обеспечения (ПО).
Классы имеют следующее назначение:
Класс CObject — системный абстрактный класс для наследования общих свойств объектов системы классов.
Класс AbsStreet — абстрактный класс, в котором учтены общие свойства улиц.
Класс AbsHome — абстрактный класс, в котором учтены общие свойства домов, размещаемых на улицах.
Класс Street — класс улиц, для создания объекта типа улица, позволяющий создавать объекты, учитывающие свойства: название, список домов, число домов и др.
Класс Home — класс дома, позволяющий создавать объекты описывающие дома, в которых учтены свойства: номер, число квартир, число жителей, признак ремонта и др.
Примечание 1. В данном руководстве описаны только те классы и их составляющие (методы и свойства), которые необходимы пользователю для реализации своих задач. Это классы Street и Home. Описание других составляющих системы классов улиц и домов можно найти в документах: “Техническое описание” и “Описание тестового примера”.
Примечание 2. Результаты работы фрагментов текста программ можно найти в документах: “Программа и методика испытаний” и “Описание тестового примера”.
6 Подключение системы классов в программу
В данном фрагменте подключаются заголовочные файлы библиотек: ввода вывода (iostream), стандартных классов MFC (stdafx.h) и собственной системы классов улиц и домов (DZ.h, DZ_Class.h, DZ_LIB.cpp). Кроме того, объявлено использование именованного пространство стандартных функций (std). В проект подключается модуль — DZ_LIB.cpp.
#include «stdafx.h»
#include » DZ_Class.h «
#include <iostream>
using namespace std;
7 Общие данные и переменные
В программах, использующих систему классов улиц и домов применяются следующие глобальные переменные и перечисления.
|
№ |
Описание данных и перечислений |
Назначение |
Параметры и значения |
|
|
enum BOOL {false=0 , true}; |
Логические значения |
false , true |
|
|
static BOOL DestructorDeleteObj; |
Глобальный Признак удаления объектов |
false , true |
|
|
enum HomeType{fast, multiple , complex}; |
Тип дома |
Fast — простой, multiple —многокорпусный, complex — сложный |
|
|
enum StreetType{one, two , more }; |
Тип улицы: |
one — односторонняя, two — двухсторонняя, more — много полос |
|
|
enum TypeAddDel {tail, head, Number ,NumbAfter, NumbCurrent, NumbBefore, AssbAfter, AssCurrent, AssBefore , createObj , nocreateObj , deleteObj, nodeleteObj }; |
Режим добавления и удаления объектов |
head — голова (начало), tail – хвост (конец), Number – номер (по номеру). createObj – новый объект nocreateObj – не создается deleteObj — удаляется nodeleteObj – не удаляется |
8 КЛАСС ДОМОВ — Home
Класс Home. Дом – объекты данного типа содержат информацию о номере дома, этажности, числе жителей и квартир, необходимости ремонта дома и типе дома. Предусматривается возможность изменения параметров дома.
9 Данные и переменные класса Home
В классе Home объявлены следующие свойства доступные пользователю:
|
Переменная |
Тип свойства |
Защита |
Назначение |
|
Home_Number |
char * |
public |
Номер дома (имя) |
|
iHome |
int |
public |
Номер дома числовой |
|
EtagCount |
int |
public |
Число этажей |
|
MenCount |
int |
public |
Число жителей |
|
TypeHome |
HomeType |
public |
Тип дома (перечисление: простой, многокорпусный, сложный) |
|
NumbApartament |
int |
public |
Число квартир |
|
HomeRemont |
BOOL |
public |
Признак необходимости ремонта дома |
10 Конструкторы класса Home
В классе Home описаны следующие конструкторы:
|
№ п/п |
Прототип |
Тип возврата |
Назначение /Параметры |
|
|
Home() |
Home & |
Нет |
|
|
Home( Home & H) |
Home & |
Новый на основе ссылки на объект типа дом: Home & |
|
|
Home( Home * pH) |
Home & |
Новый на основе указателя на объект типа дом: Home * |
|
|
Home(const char *HomName, const char *Number) |
Home & |
Новый с параметрами: HomName — имя Number — номер дома |
|
|
Home(const char *HomName, const char *Number, int Numb) |
Home & |
Новый с параметрами: HomName — имя дома, Number — номер дома Numb — номер для поиска |
|
|
Home(const char *HomName, const char *Number, int Numb, int Etag, int Men=0,HomeType Type = fast,int Apart=0) |
Home & |
Новый с параметрами: HomName — имя дома, Number — номер дома Numb — номер для поиска, Etag — этажность, Men — число жителей, Type – тип дома, Apart — число квартир |
Примеры использования конструкторов: