Разработка руководства пользователя программного средства по индивидуальному заданию

Подборка по базе: ГорбачевТаблица для анализа агрегаторов вакансий.docx, Шаблон для заполнения анализа деятельности МО.docx, Ответы — РОСДИСТАНТ — Теория экономического анализа.docx, Презентация_Оптические методы анализа_.pdf, Карта анализа занятия учителя.docx, основы эконом анализа 2.docx, ПМ 04.Организация и управление процессом изготовления рекламного, _! Корковое представительство чувствительного анализатора_ _+зад, методика анализа текста.doc, Бокарева София Издержки обращения и методы их анализа в торговых

Цель: получение навыков разработки руководства пользователя программного средства

Теоретические вопросы

• Перечень и комплектность документов на информационные системы согласно ЕСПД и ЕСКД.
• Задачи документирования.
• Проектная документация. Техническая документация. Отчетная документация.
• Пользовательская документация. Маркетинговая документация.

Задание № 1

Разработать руководство пользователя программного средства (см. практическая работа №1).

Лабораторная работа №1 «Изучение средств автоматизированного документирования»

Цель: научиться анализировать средства автоматизированного документирования; познакомиться с основными элементами управления (виджетами); приобрести умения проектирования графического интерфейса пользователя для последующего документирования; осуществлять постановку задач по обработке информации; проводить анализ предметной области; осуществлять выбор модели и средства построения информационной системы и программных средств; проектировать интерфейс приложения с использованием программных средств

Задание №1

1. Создайте карту навигации для выбранной системы. На карте в зависимости от специфики системы выделите разделы, доступные различным пользователям в зависимости от роли, опишите условия перехода из различных разделов (при необходимости).
2. Используя графический редактор на выбор, создайте макеты графического интерфейса пользователя (от каждого члена бригады – не менее 3 макетов). Предлагаемые системы:
   • Microsoft Visio 2010;
   • Axure;
   • Adobe Photoshop;
   • Balsamiq;
   • Cacoo.
3. Для разработанных макетов подготовьте их текстовое описание в виде таблицы 1.

Таблица. Текстовое описание

1. Оформить отчет к лабораторной работе.

• Титульный лист.
• Цель работы.
• Навигационная схема (карта навигации).
• Макеты графического интерфейса пользователя.
• Описание элементов управления по таблице.
• Выводы.

Пример отчѐта

Сперва составляем навигационную схему выбранного сайта. Для примера взята карта навигации интернет-банкинга ОАО «АСБ Беларусбанк» (ibank.asb.by). Информация на карте навигации аналогична разделу

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

Рисунок 1. Интерфейс

Карту навигации можно составить в виде дерева.

Рисунок 2. Карта навигации

Далее необходимо составить Макеты графического интерфейса пользователя (не менее 3 макетов): чтобы создать макет можно использовать программу Microsoft Visio.

Рисунок 3. Начальная страница (ibank.asb.by)

Теперь нужно описать элементы управления для каждого составленного макета. В столбце Название поля нужно перечислить все элементы, размещѐнные на макете. В столбце Тип – указать тип, т.е. чем является элемент (ссылка, текст, поле для ввода, кнопка, чекбокс и т.п.). В столбцах Условия видимости и Условия доступности нужно указать кому виден и доступен каждый элемент интерфейса. В столбце Описание нужно немного подробнее описать для чего этот элемент, какие он действия совершает.

Таблица 1. Описание элементов управления

Задание №2

Изучить и описать технологии штрихового кодирования (Bar Code Technologies) сбора информации.

Задание №3

Изучить и описать технологии радиочастотной идентификации (RFID –

Radio Frequency

Identification Technologies) сбора информации.

Задание №4

Изучить и описать карточные технологии (Card Technologies) сбора информации.

Задание №5

Изучить и описать технологии сбора данных (Data Communications Technologies).

Задание №6

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

Задание №7

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

• в экономических информационных системах (например, маркетинга);
• в геоинформационных системах;
• в статистических информационных системах;
• в информационных системах управления производственными процессами.

Задание №8 Оформить отчет.

Задание №9

1. Откройте в браузере сайт Eskone по адресу https://esk.one/.
2. Пройдите регистрацию.
3. В левом верхнем углу выберите Создать проект.
4. Нажмите на новый проект для редактирования.

Рисунок 1. Интерфейс сервиса

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

Список литературы

Электронные издания (электронные ресурсы)

1. Гвоздева, В.А. Основы построения автоматизированных информационных систем [Электронный ресурс]: учебник / В.А. Гвоздева, И.Ю. Лаврентьева. — М. : ИД

«ФОРУМ» : ИНФРА-М, 2019. — 318 с. — Режим доступа:

http://znanium.com/catalog/product/989678 (ЭБСZnanium)

1. Гвоздева, В.А. Информатика, автоматизированные информационные технологии и системы [Электронный ресурс]: учебник / В.А. Гвоздева. — М.: ИД «ФОРУМ»: ИНФРА-М, 2019. — 542 с. — Режим доступа: http://znanium.com/catalog/product/999615 (ЭБСZnanium)
2. Затонский, А.В. Информационные технологии: разработка информационных моделей и систем: учебное пособие / А.В. Затонский. — Москва: РИОР: ИНФРА-М, 2020. — 344 с. + Доп. материалы [Электронный ресурс]- Режим доступа: http://znanium.com/catalog/product/1043097
3. Разработка, внедрение и адаптация программного обеспечения отраслевой направленности : учеб. пособие / Г.Н. Федорова. — М.

:КУРС : ИНФРА-М, 2019. —

336 с.- Текст : электронный. -Режим доступа:

http://znanium.com/catalog/product/989682

1. Языки программирования [Электронный ресурс]: учеб. пособие / О.Л. Голицына, Т.Л. Партыка, И.И. Попов. — 3-е изд., перераб. и доп. — М. : ФОРУМ : ИНФРА-М, 2018. — 399 с. — Режим доступа: http://znanium.com/bookread2.php?book=973007 (ЭБСZnanium)

Методические издания

1. Игнатенко, Е.С. Методические указания по выполнению практических работ по МДК

05.01 Проектирование и дизайн информационных систем .–

Нефтеюганск: НИК(филиал) ФГБОУ ВО «ЮГУ», 2019 [Электронный ресурс] Режим доступа: локальная сеть филиала.

Периодические издания

1. Программные продукты и системы [Электронный ресурс]: журнал.- Тверь: — Научно- исследовательский институт

«Центрпрограммсистем» Электронно-библиотечная система «Лань»

: [сайт]. — Режим доступа: https://e.lanbook.com/journal/2276

Руководство пользователя – это основной документ в составе эксплуатационной документации на автоматизированную систему (ГОСТ 34). Очевидно ли это?

Назначение руководства пользователя

Цель создания документа заключается в том, чтобы предоставить пользователю возможность самостоятельно решать свои прикладные задачи с помощью системы. Этой цели может служить и введение в предметную область, и ознакомление со всеми возможностями программы, и описание конкретных процедур решения задач, и приведение различных инструкций. Иногда Руководство пользователя больше похоже на справочник, к которому можно обращаться в процессе работы, а иногда – на учебник, который позволяет изучить принципы работы с программой и ее возможности, а затем применять их на практике.

Состав типового руководства пользователя

Конкретный подход к написанию определяется многими факторами:

– назначением программы и областью ее применения;

– сложностью программы;

– количеством разнообразных вариантов использования.

Принимая во внимание все различия и особенности, сложно привести структуру любого Руководства пользователя к одному виду. Тем не менее, РД 50-34.698 предлагает нам такой список разделов:

– Введение, где указывают область применения ПО, краткое описывают его возможности, требуемый уровень знаний пользователя и список документов, которые необходимо изучить помимо настоящего руководства;

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

– Подготовка к работе, где описывают комплектность дистрибутива, порядок установки и загрузки программы, а также способ проверки ее работоспособности;

– Описание операций, представляет собой основной раздел, где описывают функции программы, процессы работы с данными, выполнение конкретных задач пользователя;

– Аварийные ситуации, где описывают действия в нештатных ситуациях – сбоях в программе, ошибок в данных и т.д.;

– Рекомендации по освоению, где приводят методические рекомендации по изучению программы и примеры использования.

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

Стандарты для руководства пользователя

Наличие Руководства пользователя регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства пользователя могут отличаться друг от друга по способу, методике и стилю изложения.

Стоимость разработки руководства пользователя

Грамотно написанное Руководство пользователя может сэкономить значительное количество времени на обучение и адаптацию пользователя к программе, а также снизить количество ошибок в работе что, в свою очередь, повышает экономическую эффективность системы. Если вы не хотите вникать во все тонкости создания Руководства пользователя, но хотите иметь полный, качественный и полезный документ – обратитесь в компанию ТехРайтКонсалт, и мы применим весь наш опыт и знания для решения вашей задачи по доступной цене!

Возможно, вас также заинтересует:

– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства оператора.

Практическая работа №24 —
25

Составление руководства пользователя
ИС

Цель работы:
Ознакомиться с процедурой разработки руководства пользователя   на  создание  программного
 продукта  (ПП)  с применением РД 50-34-698-90 «Автоматизированные системы
требования к содержанию документов»

Основные теоретические
сведения

Формальные
требования к документации программного обес­печения опи­са­ны в ЕСПД (Единая
система программной доку­ментации), неформально: состав документации к
программному обеспечению состоит из опи­са­ния его внешнего эффекта и описания
его внутреннего устройства.

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

Вторая часть —
«Руководство программисту» необходима при модификации программного обеспечения
или при необходимости исправить в нем ошибку.

В целом,
документация к программному обеспечению может содержать ниже перечисленные
сведения:

1.Наименование
ПО и описание задачи, которую оно решает.

2.Область
применимости ПО.

3.Режим работы
ПО, сообщения, выдаваемые по ходу его работы, ответы пользователя на них (если
это необходимо).

4.Исходные
данные, необходимые для работы ПО; а также выдаваемые им результаты;.

5.Правила
подготовки исходных данных на внешних носителях (если они применяются) и вид
выдаваемой информации.

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

7.Описания
форм, объектов. Опись свойств форм и объектов.

8.Тексты
программ, процедур (в виде распечатки ЭВМ) с комментариями.

9.Тесты.

10.Инструкция
(руководство) пользователю.

Инструкция по
использованию программы (или просто «Инструкция пользователю», или «Руководство
для пользователя») — это выдержка из полной документации, предназначенная для
эксплуатации программы. Она представляет собой независимый документ для
пользователя программы, в котором описывается: что делает программа и как им
пользоваться.

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

Первая часть
инструкции является описательной и должна содержать:

-наименование
программы;

-краткое
описание программы;

-перечень
выполняемых программой функций;

-краткую
характеристику метода (или методов) решения поставленной задачи, его достоинство
и недостатки;

-полную
библиографическую ссылку на полное описание  метода;

-описание
входных и выходных данных.

-описание
структуры базы данных (если она имеется), всех ее таблиц в словесной
(вербальном) форме.

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

Следует
помнить, что пользователь по своей квалификации не является программистом и
поэтому его работа с программой описывается на понятном ему языке и достаточно
подробно, а именно:

-как запустить
программу;

-как продолжить
работу с программой (описывается подробный интерактивный режим работы
пользователя с программой);

-подготовка и
ввод исходных данных в программу;

-как
реагировать на запросы программы;

-как вести
работу в исключительных ситуациях;

-как
реагировать на ошибки;

-как
восстановить работу программы в случае аварийного его завершения;

-как получить
требуемый результат;

-как правильно
закончить работу с программой (запланированный программой выход);

-другие
сведения, необходимые пользователю программы.

Задания для выполнения

1.Во
время выполнения лабораторной работы необходимо составить документ «Руководство
пользователю» к разработанной ранее программе.

2.Работа
должна быть оформлена в виде документа «Руководство пользователя» согласно РД
50-34-698-90 «Автоматизированные системы требования к содержанию документов».

3.
Сдать и защитить работу.

Аннотация. В данной статье рассмотрены особенности разработки руководства пользователя для программного обеспечения «Зарплата и кадры». Автором изучены назначение и структура руководства пользователя. 

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

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

Основная цель документа «Руководство пользователя» заключается в обеспечении пользователя необходимой информацией для самостоятельной работы с программой или автоматизированной системой. Документ должен отвечать на следующие вопросы: назначение программы, её возможности; что необходимо для обеспечения ее корректного функционирования и, что делать в случае отказа системы [1].

В статье приводится пример структуры «Руководства пользователя» для программного  обеспечения «Зарплата и кадры», используемого в Инновационном Евразийском университете (ИнЕУ).

«Руководство пользователя» должно состоять из двух частей:

• руководство пользователя;
• руководство оператора.

Структура руководства пользователя содержит:

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

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

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

1. Назначение и   условия   применения.   Раздел   подразделяет   основную   задачу    приложения на подзадачи и описывает каждую из них.

• Виды деятельности и функции. В этом подразделе описываются функции, для автоматизации которых предназначена программа.
• Условия применения. В подразделе описываются условия, при которых обеспечивается полноценное применение программного обеспечения. В качестве таких условий могут выступать требования к аппаратному  обеспечению,  на  котором  будет  использоваться  программное  обеспечение, и квалификация сотрудников, которые будут работать с описываемым программным  продуктом. Например,  для  корректной  работы   программного   обеспечения   «Зарплата   и   кадры» рекомендовано не выполнять на компьютере параллельно других ресурсоемких задач [2]. 

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

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

1. Проверка работоспособности. В подразделе описываются показатели, по которым можно определить, что программное обеспечение работает нестабильно. Процесс проверки программного обеспечения «Зарплата и кадры» требует определенного промежутка времени, так как необходимо протестировать большое количество различных функций при различных условиях.
2. Описание операций. Это основной раздел, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем. Если работа автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе, его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе. Далее в руководстве пользователя следует представить  описание функций, разбитых на отдельные операции. Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения.

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

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

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

Структура руководства оператора содержит:

1. Установка а сервер. Программное обеспечение «Зарплата и кадры» является многопользовательским, следовательно, оно имеет централизованную базу данных. В разделе описывается процесс установки программного обеспечения на сервер. Пошаговая инструкция дает точные указания, каким образом необходимо выполнить установку, в зависимости от технического состояния сервера. Настройка сервера для обеспечения работоспособности программного приложения «Зарплата и кадры» является основным моментом администрирования, так как сервер хранит большие объемы различной информации.
2. Установка локальная. В разделе описывается процесс настройки компьютеров, использующих программное приложение, также даются рекомендации по оптимизации настройки рабочих станций, чтобы улучшить процесс взаимодействия сервера и компьютеров пользователей.
3. Администрирование пользователей. В разделе подробно описывается процесс администрирования учетных записей пользователей программного обеспечения «Зарплата и кадры». Подробная инструкция описывает все   ситуации,   которые   могут   возникнуть   при   управлении   пользователями.   Например, с помощью   данной    подсистемы    можно    централизованно    завершать    все    активные    соединения с информационной базой и устанавливать блокировку новых соединений на определенный  период времени.   Такая    возможность    полезна    при    выполнении    различных    административных действий с информационной базой.
4. Информационная база. В разделе рассматриваются вопросы администрирования, сохранения, переноса базы данных. Описаны рекомендации по настройке базы данных. Например, рассматривается ситуация резервного копирования. Программное обеспечение «Зарплата и кадры» позволяет создавать резервные копии информационной базы. Резервное копирование может выполняться как в автоматическом режиме, так и в ручном. Для автоматического режима предварительно необходимо выполнить настройки. В любой момент можно восстановить данные информационной базы из созданной ранее резервной копии.
5. Технические неполадки. Этот раздел содержит информацию о возможных технических проблемах, которые могут возникнуть в процессе эксплуатации программного обеспечения. Рассматриваются проблемы, возникающие в результате некорректной работы оборудования, а также ситуации, возникающие в результате некорректного использования функций программного обеспечения «Зарплата и кадры». 

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

Документ «Руководство пользователя» является неотъемлемой частью программного обеспечения, следовательно и чем лучше, он будет составлен, тем меньше проблем будет возникать в процессе эксплуатации разработанной программы.

СПИСОК ЛИТЕРАТУРЫ

1. Радченко М.Г. 1С: Предприятие 0. Практическое пособие разработчика. Примеры и типовые приемы . – 1С – Паблишинг, 2004. – 656 с.
2. Тимофеев Г., Шумейко Д. Конфигурирование и администрирование 1С: Предприятия. – Ростов н/Д: Феникс, 2003. – 320 с.