Руководство виды программ - Большая энциклопедия инструкций и руководств

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

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

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

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

Общие советы по созданию пользовательской документации

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

После этого важно подумать о том:

Где пользователь будет к нему обращаться: дома, на работе, в машине?
Как часто он будет его просматривать?
Насколько объективно сложен для понимания продукт?

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

Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?

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

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

В первом разделе желательно рассказать общую информацию о программе:

Для чего создан продукт.
Какие задачи он решает.
Какие основные выгоды от использования для клиента.

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

Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.

Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.

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

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

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

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.

При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.

Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

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

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

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert

Николай Вальковец, разработчик компании 2V

«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».

Прочитать кейс компании V2

Подытожим

Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

Источник

Практическая работа №13

Тема: Руководство пользователя.

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

Теоретические
сведения.

Руководство
пользователя (user guide или user
manual), руководство по эксплуатации, руководство
оператора — документ, назначение которого — предоставить людям помощь
в использовании некоторой системы. Документ входит в состав технической
документации на систему и, как правило,
подготавливается техническим писателем.

Большинство
руководств пользователя помимо текстовых описаний содержит изображения. В
случае программного обеспечения, в
руководство обычно включаются снимки экрана, при
описании аппаратуры — простые и понятные рисунки или фотографии. Используется
стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до
минимума либо подробно объясняется.

Содержание

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

·
Аннотацию, в
которой приводится краткое изложение содержимого документа и его назначение

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

·
Страницу
содержания

·
Главы,
описывающие, как использовать, по крайней мере, наиболее важные функции
системы

·
Главу, описывающую
возможные проблемы и пути их решения

·
Часто
задаваемые вопросы и ответы
на них

·
Где
ещё найти информацию по предмету, контактная информация

·
Глоссарий и, в
больших документах, предметный указатель

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

Стандарты

Структура и
содержание документа Руководство пользователя автоматизированной
системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и
содержание документов Руководство оператора, Руководство
программиста, Руководство системного программиста регламентированы
ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

·
Комплекс
стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)

· РД
50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

·
Единая система конструкторской документации (ЕСКД)
определяет документ «Руководство по эксплуатации» и другие документы:

· ГОСТ
2.601-2013 Эксплуатационные документы

· ГОСТ
2.610-2006 Правила выполнения эксплуатационных документов

·
Единая
система программной документации (ЕСПД)
определяет документы «Руководство оператора», «Руководство по техническому обслуживанию»
и их структуру:

· ГОСТ
19.101-77 Виды программ и программных документов

· ГОСТ
19.105-78 Общие требования к программным документам

· ГОСТ
19.505-79 Руководство оператора. Требования к содержанию и оформлению

· ГОСТ
19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и
оформлению.

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

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

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

Руководящими
стандартами для создания документа Руководство пользователя могут
являться как РД
50-34.698-90 в п.п. 3.4. «Руководство пользователя», так
и ГОСТ
19.505-79 «Руководство оператора. Требования к содержанию и оформлению». Ниже для
сравнения приведены структуры документа согласно двум перечисленным стандартам.

РД 50-34.698-90 (п.п. 3.4 Руководство пользователя)	ГОСТ 19.505-79 Руководство оператора
Введение
Область применения
Описание возможностей
Уровень подготовки пользователя
Перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю
Назначение и условия применения
Виды деятельности и функции, для автоматизации которых предназначена программа	Назначение программы
Условия, при которых обеспечивается применение программы	Условия выполнения программы
Подготовка к работе	Выполнение программы
Состав и содержание дистрибутивного носителя данных
Порядок загрузки данных и программ	Порядок загрузки, запуска и завершения программы
Проверка работоспособности
Описание операций	Описание функций
Описание всех выполняемых функций, задач, комплексов задач, процедур
Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур
Аварийные ситуации (действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных, и т.п. )	Сообщения оператору
Рекомендации по освоению

Таким образом, мы можем выделить следующие основные разделы руководства
пользователя:

ü Назначение
системы;

ü Условия применения
системы;

ü Подготовка системы
к работе;

ü Описание операций;

ü Аварийные
ситуации.

Назначение системы

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

Пример:

«Корпоративный
интранет портал предназначен для повышения корпоративной культурыр организации
эффективного взаимодействия сотрудников.

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

Условия
применения системы

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

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

Квалификация
пользователя – данный подраздел должен содержать требования к навыкам и знаниям
пользователя (пример: «Пользователи должны обладать навыками работы с
операционной системой Windows XP»);

Подготовка
системы к работе

Данный
раздел документа Руководство пользователя должен содержать пошаговую инструкцию
для запуска приложения. К этапу подготовки системы к работе можно отнести
установку дополнительных приложений (при необходимости), идентификацию,
аутентификацию и т.п.

Описание
операций

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

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

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

Пример:

«4.1
Согласование проекта. Данный процесс предназначен для организации работы
сотрудников, участвующих в разработке и согласовании проекта.
Автор проекта создает запись в Системе и прикрепляет пакет необходимой
документации, далее проект передается на согласование руководящими лицами.
Руководители после ознакомления с проектом могут подтвердить его или отправить
на доработку Автору.

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

Наименование
проекта;

Описание
проекта;

Следующие
поля заполняются автоматически:

Дата
создания проекта – текущая дата;

Автор –
ИФО и должность автора проекта.»

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

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

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

Аварийные
ситуации

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

Ниже представлен пример (образец)
документа «Руководство пользователя«, разработанного на
основании методических указаний РД
50-34.698-90.

Данный документ формируется
IT-специалистом, или функциональным специалистом, или техническим писателем в
ходе разработки рабочей документации на систему и её части на стадии «Рабочая
документация».

Для формирования руководства пользователя
в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической
системы «Корпоративное хранилище данных».

Ниже приведен состав руководства
пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к
содержанию и текст примера заполнения (выделен вертикальной
чертой).

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

1.
Введение.

2.
Назначение и
условия применения.

3.
Подготовка к
работе.

4.
Описание операций.

5.
Аварийные
ситуации.

6.
Рекомендации по
освоению.

1. Введение

В разделе «Введение»
указывают:

1.
область применения;

2.
краткое
описание возможностей;

3.
уровень
подготовки пользователя;

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

1.1. Область применения

Требования настоящего документа
применяются при:

· предварительных комплексных
испытаниях;

· опытной эксплуатации;

· приемочных испытаниях;

· промышленной эксплуатации.

1.2. Краткое описание возможностей

Информационно-аналитическая
система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации
технологии принятия тактических и стратегических управленческих решений
конечными бизнес-пользователями на основе информации о всех аспектах
финансово-хозяйственной деятельности Компании.

ИАС КХД предоставляет возможность
работы с регламентированной и нерегламентированной отчетностью.

При работе с отчетностью
используется инструмент пользователя Oracle Discoverer Plus, который
предоставляет следующие возможности:

· формирование табличных и
кросс-табличных отчетов;

· построение различных диаграмм;

· экспорт и импорт результатов
анализа;

· печать результатов анализа;

· распространение результатов
анализа.

1.3. Уровень подготовки
пользователя

Пользователь ИАС КХД должен иметь
опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet
Explorer, Oracle Discoverer, а также обладать следующими знаниями:

· знать соответствующую предметную
область;

· знать основы многомерного анализа;

· понимать многомерную модель
соответствующей предметной области;

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

Квалификация пользователя должна
позволять:

· формировать отчеты в Oracle
Discoverer Plus;

· осуществлять анализ данных.

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

· Информационно-аналитическая
система «Корпоративное хранилище данных». ПАСПОРТ;

· Информационно-аналитическая
система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.

2. Назначение и условия применения
Oracle Discoverer Plus

В разделе «Назначение и
условия применения» указывают:

1.
виды
деятельности, функции, для автоматизации которых предназначено данное средство
автоматизации;

2.
условия, при
соблюдении (выполнении, наступлении) которых обеспечивается применение средства
автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация
технических средств, операционная среда и общесистемные программные средства,
входная информация, носители данных, база данных, требования к подготовке
специалистов и т. п.).

Oracle Discoverer Plus в составе
ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по
показателям деятельности, а также для углубленного исследования данных на
основе корпоративной информации хранилища данных.

Работа с Oracle Discoverer Plus в
составе ИАС КХД возможна всегда, когда есть необходимость в получении
информации для анализа, контроля, мониторинга и принятия решений на ее основе.

Работа с Oracle Discoverer Plus в
составе ИАС КХД доступна всем пользователям с установленными правами доступа.

3. Подготовка к работе

В разделе «Подготовка к работе»
указывают:

1.
состав и
содержание дистрибутивного носителя данных;

2.
порядок
загрузки данных и программ;

3.
порядок
проверки работоспособности.

3.1. Состав и содержание
дистрибутивного носителя данных

Для работы с ИАС КХД необходимо
следующее программное обеспечение:

1.
Internet
Explorer (входит в состав операционной системы Windows);

2.
Oracle
JInitiator устанавливается автоматически при первом обращении пользователя к
ИАС КХД.

3.2. Порядок загрузки данных и
программ

Перед началом работы с ИАС КХД на
рабочем месте пользователя необходимо выполнить следующие действия:

1.
Необходимо
зайти на сайт ИАС КХД ias-dwh.ru.

2.
Во время
загрузки в появившемся окне «Предупреждение о безопасности», которое
будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator»
…’ Нажимаем на кнопку «Да».

3.
После чего
запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next
и затем OK.

3.3. Порядок проверки
работоспособности

Для проверки доступности ИАС КХД с
рабочего места пользователя необходимо выполнить следующие действия:

1.
Открыть
Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer»
на рабочем столе или вызвать из меню «Пуск».

2.
Ввести в
адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».

3.
В форме аутентификации
ввести пользовательский логин и пароль. Нажать кнопку «Далее».

4.
Убедиться, что
в окне открылось приложение Oracle Discoverer Plus.

В случае если приложение Oracle
Discoverer Plus не запускается, то следует обратиться в службу поддержки.

4. Описание операций

В разделе «Описание
операций» указывают:

1.
описание всех
выполняемых функций, задач, комплексов задач, процедур;

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

Для каждой операции обработки
данных указывают:

1.
наименование;

2.
условия, при
соблюдении которых возможно выполнение операции;

3.
подготовительные
действия;

4.
основные
действия в требуемой последовательности;

5.
заключительные
действия;

6.
ресурсы, расходуемые
на операцию.

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

4.1. Выполняемые функции и задачи

Oracle Discoverer Plus в составе
ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

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

4.2. Описание операций
технологического процесса обработки данных, необходимых для выполнения задач

Ниже приведено описание
пользовательских операций для выполнения каждой из задач.

Задача:
«Визуализация отчетности»

Операция 1: Регистрация на портале
ИАС КХД

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

1.
Компьютер
пользователя подключен к корпоративной сети.

2.
Портал ИАС КХД
доступен.

3.
ИАС КХД
функционирует в штатном режиме.

Подготовительные
действия:

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

Основные
действия в требуемой последовательности:

1.
На иконке «ИАС
КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.

2.
В открывшемся
окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя.
Нажать кнопку «Далее».

Заключительные
действия:

Не требуются.

Ресурсы,
расходуемые на операцию:

15-30 секунд.

Операция 2: Выбор отчета

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

Успешная регистрация на Портале
ИАС КХД.

Подготовительные
действия:

Не требуются.

Основные
действия в требуемой последовательности:

1. В появившемся окне «Мастер
создания рабочих книг» поставить точку напротив пункта «Открыть существующую
рабочую книгу».

2. Выбрать нужную рабочую книгу и
нажать кнопку «Откр.»:

Заключительные действия:

После завершения работы с отчетом
необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».

Ресурсы,
расходуемые на операцию:

15 секунд.

Задача:
«Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

5. Аварийные ситуации

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

В случае возникновения ошибок при
работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к
сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к
ответственному Администратору ИАС КХД.

Класс ошибки	Ошибка	Описание ошибки	Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД	Сервер не найден. Невозможно отобразить страницу	Возможны проблемы с сетью или с доступом к порталу ИАС КХД.	Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД.
Ошибка: Требуется ввести действительное имя пользователя	При регистрации на портале ИАС КХД не введено имя пользователя.	Ввести имя пользователя.
Ошибка: Требуется ввести пароль для регистрации	При регистрации на портале ИАС КХД не введен пароль.	Ввести пароль.
Ошибка: Сбой аутентификации. Повторите попытку	Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована.	Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД.
Сбой в электропитании рабочей станции	Нет электропитания рабочей станции или произошел сбой в электропитании.	Рабочая станция выключилась или перезагрузилась.	Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: — нажать кнопку «Пуск» — выбрать пункт «Выполнить» — в строке ввода набрать команду telnet ias_dwh.ru 80 — если открылось окно Telnet, значит соединение возможно. Повторить попытку подключения (входа) в ИАС КХД
Сбой локальной сети	Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД	Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД	Перезагрузить рабочую станцию. Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды: — нажать кнопку «Пуск» — выбрать пункт «Выполнить» — в строке ввода набрать команду telnet ias_dwh.ru 80 — если открылось окно Telnet, значит соединение возможно. После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД.

6. Рекомендации по освоению

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

Рекомендуемая литература:

· Oracle® Business Intelligence Discoverer
Viewer User’s Guide

· Oracle® Business Intelligence Discoverer
Plus User’s Guide

Рекомендуемые курсы обучения:

· Discoverer 10g: Создание запросов
и отчетов

В качестве контрольного примера
рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в
п. 4.2. настоящего документа.

Ход
работы:

Задание 1.
Изучите
свой вариант руководства пользователя. Опишите его по следующему плану:

1) для
какого продукта, предназначено руководство пользователя (наименование, модель);

2)
основные технические характеристики продукта;

3)
основные разделы руководства пользователя (название раздела и краткое его
описание)

Задание 2.
Откройте
документ «Образец руководства пользователя», заполните в нем первые разделы для
своего вымышленного программного продукта.

Сделайте
вывод
о проделанной работе.

Контрольные
вопросы:

1) Дайте
определения понятиям «руководство пользователя», «инструкция по эксплуатации»

2) Какие
основные разделы должно содержать руководство пользователя?

3) Какие
стандарты описывают Руководство пользователя Руководство оператора, Руководство
программиста, Руководство системного программиста?

4) Что
описывает раздел «назначение системы»?

5) Что
указывается в разделе «условия применения системы»?

6) Какая
информация содержится в разделе «Описание операций»?

Виды
программ..

1.1.
Программу (по ГОСТ 19781-90) допускается
идентифицировать и применять самостоятельно
и (или) в составе других программ.

1.2.
Программы подразделяют на виды,
приведенные в табл.

Вид программы	Определение
Компонент	Программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса
Комплекс	Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса

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

1.2,1.3. (Измененная
редакция, Изм. № 1).

Виды программных продуктов

2.1. К
программным относят документы, содержащие
сведения, необходимые для разработки,
изготовления, сопровождения и эксплуатации
программ.

2.2. Виды программных
документов и их содержание.

Спецификация
— содержит состав программы и документации
на нее. Выполняется на стадии рабочего
проекта. Является обязательным документом
для комплексов и тех компонентов,
которые могут иметь самостоятельное
применение.
Ведомость держателей подлинников
(код вида документа — 05) — содержит
перечень предприятий, на которых хранят
подлинники программных документов.
Выполняется на стадии рабочего проекта.
Необходимость составления документа
на этапе утверждения технического
задания (по согласованию).
Текст
программы (код вида
документа — 12) — содержит запись программы
с необходимыми комментариями. Выполняется
на стадии рабочего проекта. Необходимость
— по согласованию.
Описание
программы (код вида
документа — 13) — содержит сведения о
логической структуре и функционировании
программы. Выполняется на стадии
рабочего проекта. Необходимость — по
согласованию.
Программа
и методика испытаний
(код вида документа — 51) — содержит
требования, подлежащие проверке при
испытаниях программы, а также порядок
и методы их контроля. Выполняется на
стадии рабочего проекта. Необходимость
— по согласованию.
Техническое
задание — содержит
назначение и область применения
программы, технические, технико-экономические
и специальные требования, предъявляемые
к программе, необходимые стадии и сроки
разработки, виды испытаний. Выполняется
на стадии технического задания и
является обязательным документом для
комплекса. Необходимость составления
технических заданий на компоненты
определяется по согласованию с
заказчиком.
Пояснительная
записка (код вида
документа — 81) — содержит схему алгоритма,
общее описание алгоритма и /или
функционирования программы, а также
обоснование принятых технических и
технико-экономических решений.
Выполняется на стадии эскизного и
технического проектов. Необходимость
— по согласованию.
Эксплуатационные документы —
содержит сведения для обеспечения
функционирования и эксплуатации
программы. Выполняются на стадии
рабочего проекта. Необходимость — по
согласованию для каждого документа
отдельно.

2.3. Виды
эксплуатационных документов и их
содержание

Ведомость эксплуатационных документов
(код вида документа — 20) — содержит
перечень эксплуатационных документов
на программу.
Формуляр (код вида документа —
30) — содержит основные характеристики
программы, комплектность и сведения
об эксплуатации программы.
Описание
применения (код
вида документа — 31) — содержит сведения
о назначении программы, области
применения, применяемых методах, классе
решаемых задач, ограничениях для
применения, минимальной конфигурации
технических средств.
Руководство
системного программиста
(код вида документа — 32) — содержит
сведения для проверки, обеспечения
функционирования и настройки программы
на условия конкретного применения.
Руководство
программиста (код
вида документа — 33) — содержит сведения
для эксплуатации программы .
Руководство
оператора (код вида
документа — 34) — содержит сведения для
обеспечения процедуры общения оператора
с вычислительной системой в процессе
выполнения программы .
Описание
языка (код вида документа
— 35) — содержит описание синтаксиса и
семантики языка.
Руководство
по техническому обслуживанию
(код вида документа — 46) — содержит
сведения для применения тестовых и
диагностических программ при обслуживании
технических средств.

Помимо оговариваемых стандартом, на
программу могут выпускаться и другие
программные и эксплуатационные документы,
им присваиваются коды от 90 до 99.

2.4. В
зависимости от способа выполнения и
характера применения программные
документы подразделяются на подлинник,
дубликат и копию (ГОСТ 2.102-68), предназначенные
для разработки, сопровождения и
эксплуатации программы.

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

Код вида документа	Вид документа	Стадии разработки
Эскизный проект	Технический проект	Рабочий проект
компонент	комплекс
—	Спецификация	—	—	2	1
05	Ведомость держателей подлинников	—	—	—	3
12	Текст программы	—	—	1	3
13	Описание программы	—	—	3	3
20	Ведомость эксплуатационных документов	—	—	3	3
30	Формуляр	—	—	3	3
31	Описание применения	—	—	3	3
32	Руководство системного программиста	—	—	3	3
33	Руководство программиста	—	—	3	3
34	Руководство оператора	—	—	3	3
35	Описание языка	—	—	3	3
46	Руководство по техническому обслуживанию	—	—	3	3
51	Программа и методика испытаний	—	—	3	3
81	Пояснительная записка	3	3	—	—
90-99	Прочие документы	3	3	3	3

Условные
обозначения:

1 —
документ обязательный;

2 —
документ обязательный для компонентов,
имеющих самостоятельное применение;

3 —
необходимость составления документа
определяется на этапе разработки и
утверждения технического задания;

— —
документ не составляют.

2.2-2.5.
(Измененная редакция,
Изм. № 1).

2.6.
Допускается объединять отдельные виды
эксплуатационных документов (за
исключением ведомости эксплуатационных
документов и формуляра). Необходимость
объединения этих документов указывается
в техническом задании. Объединенному
документу присваивают наименование и
обозначение одного из объединяемых
документов.

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

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

Технические
условия разрабатывают на стадии «Рабочий
проект».

2.8.
Необходимость составления технического
задания на компоненты, не предназначенные
для самостоятельного применения, и
комплексы, входящие в другие комплексы,
определяется по согласованию с заказчиком.
(Введен дополнительно,
Изм. № 1).

В общем случае каждый документ должен
иметь:

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

Типовая структура и содержание базовых
комплектов эксплуатационных документов
на программы и данные для пользователей
ПС.

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

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

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

К основным функциям системы администрирования
относят:

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

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

Основные особенности современного
пользовательского интерфейса состоят
в следующем:

наличие механизмов управления окнами
использование готовых графических
символов (икон) для отображения
управляемых объектов
непосредственное манипулирование
графическими объектами и окнами
посредством мыши
объектно и проблемно-ориентированное
проектирование диалоговых систем.

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

Архитектура построения распределенных
приложений определяет протоколы и
интерфейсы взаимодействия клиентских
и серверных частей приложений между
собой и с ПС среды распределенной
обработки данных при выполнении или
функций поддержки интерфейсов
пользователя.

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

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

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

Обучение представляет собой процесс
обеспечения и сопровождения обучаемого
персонала.

Правила оформления лабораторных
работ.

Общие положения

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

В отчет по лабораторной работе должны
быть включены следующие пункты:

— титульный лист;

— цель работы;

— краткие теоретические
сведения;

— описание
экспериментальной установки и методики
эксперимента;

— экспериментальные
результаты;

— анализ результатов
работы;

— выводы.

Требования к содержанию отдельных
частей отчета по лабораторной работе

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

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

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

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

В нижнем поле листа указывается место
выполнения работы и год ее написания
(без слова год).

Цель работы должна отражать тему
лабораторной работы, а также конкретные
задачи, поставленные студенту на период
выполнения работы. По объему цель работы
в зависимости от сложности и многозадачности
работы составляет от нескольких строк
до 0,5 страницы.

Краткие теоретические сведения. В этом
разделе излагается краткое теоретическое
описание изучаемого в работе явления
или процесса, приводятся также необходимые
расчетные формулы. Материал раздела не
должен копировать содержание методического
пособия или учебника по данной теме, а
ограничивается изложением основных
понятий и законов, расчетных формул,
таблиц, требующихся для дальнейшей
обработки полученных экспериментальных
результатов. Объем литературного обзора
не должен превышать 1/3 части всего
отчета.

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

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

Анализ результатов работы. Раздел отчета
должен содержать подробный анализ
полученных результатов.

Выводы. В выводах кратко излагаются
результаты работы.

Отчет по лабораторной работе оформляется
на писчей бумаге стандартного формата
А4 на одной стороне листа, которые
сшиваются в скоросшивателе или
переплетаются. Допускается оформление
отчета по лабораторной работе только
в электронном виде средствами Microsoft
Office.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

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

Общие советы по созданию пользовательской документации

После этого важно подумать о том:

Где пользователь будет к нему обращаться: дома, на работе, в машине?
Как часто он будет его просматривать?
Насколько объективно сложен для понимания продукт?

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

В первом разделе желательно рассказать общую информацию о программе:

Для чего создан продукт.
Какие задачи он решает.
Какие основные выгоды от использования для клиента.

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

Видео-обзор основных возможностей программы Dr.Explain

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

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

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

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert

Николай Вальковец, разработчик компании 2V

Прочитать кейс компании V2

Подытожим

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

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

Программа или Приложение — это тип программного обеспечения, которое позволяет выполнять конкретные задачи. Когда вы открываете программу, она работает под управлением операционной системы, пока вы её не закроете. Как правило, работая за компьютером, вы будете использовать одновременно несколько программ, то есть сразу может быть открыт текстовый редактор, файловый менеджер, интернет-браузер, это процесс называют — многозадачность. А координирует работу этих программ ОС.

Сегодня программы можно скачать в интернете. Есть много бесплатных программ, которые можно использовать для решения поставленных задач. Конечно, есть и платные программные продукты, функциональные возможности которых можно получить после оплаты. Так, если вы хотите набирать тексты в текстовом редакторе MS Word и работать с электронными таблицами MS Excel, тогда придётся купить программный продукт Microsoft Office.

Подсказка: инструменты Microsoft Office доступны бесплатно в облачных хранилищах Google Drive, Яндекс.Диск, Облако@mail.ru.

Технологии стремительно развиваются, появляются новые устройства (смартфоны, планшеты) и многие программы становятся доступны для мобильных устройств и даже для современных телевизоров с поддержкой SmartTV.

Типы программ для персонального ПК

Существует бесчисленное множество программного обеспечения для персонального компьютера, и оно подразделяется на множество категорий. По функциональности все программы отличаются, например, полнофункциональный (Microsoft Word), обладает большими функциональными возможностями, нежили Блокнот, входящий в состав операционной системы Windows.

Давайте рассмотрим самые распространённые типы программных продуктов:

Текстовые редакторы: позволяют создавать и редактировать тексты, таблицы и много других видов документов. Наиболее известный текстовый редактор — Microsoft Word.

Графические редакторы: позволяют создавать и редактировать графическое изображение (фото, картинки, рисунки) используя множество инструментов, стилей и шаблонов. Наиболее известный графический редактор — Photoshop.

Веб-Браузеры: это инструмент, который вы используете для доступа к глобальной сети Интернет. Большинство компьютеров поставляются с веб-браузером, но вы также можете загрузить другой. Примеры: Internet Explorer, Firefox, Google Chrome, Yandex-браузер и Safari.

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

Медиапроигрыватели: если вы хотите слушать музыку или смотреть фильмы на компьютере, вам понадобится программа-плеер. Для компьютеров на базе MS Windows предустановлен Windows Media Player, а для компьютеров Apple это iTunes.

Виджеты: это простые приложения, которые можно разместить на рабочем столе (если вы используете Mac или PC с Windows последнего поколения). Есть много различных типов виджетов: календари, калькуляторы, карты, заголовки новостей, заметки, часы и многое другое.

Это лишь небольшая часть категорий программного обеспечения, которое вы можете использовать на компьютере.

Установка программ на компьютер

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

Если программное обеспечение куплено в магазине, достаточно вставить установочный диск в дисковод и следовать инструкциям на экране. Если программное обеспечение, загружено из интернета, с ним будет файл readme (например, readme.txt), который включает в себя инструкции по установке и другую информацию.

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

Открытие файлов с помощью программ

Программы разрабатываются для выполнения поставленных задач и работы с определёнными типами файлов. Например, Microsoft Word может создавать и редактировать Документы Word (тип .doc .docx). Если у вас нет текстового редактора MS Word, вы не сможете открыть документы Word в «Блокноте». Например, если у вас есть файл с расширением psd – это рабочий тип файла программы Photoshop, без этой программы он бесполезен.

Существует два основных способа открыть файл:

Найдите файл на компьютере, наведите курсор мышки и дважды щёлкните левой кнопкой. Такой способ позволит открыть файл с помощью программы по умолчанию. Это значит, что операционная система по типу файла определяет, какой программой был создан файл, и какую программу следует запустить для открытия подобных файлов. Конечно, если эта программа установлена на компьютере.

Откройте программу, а затем, используя пункт меню «Файл» – «Открыть», откройте файл. Как правило, все программы имеют меню, а первым пунктом меню является пункт «Файл». Через это пункт меню можно открывать, создавать, сохранять и много другое.

Также зная основные типы файлов, вы сможете сами решить какой программой можно открыть тот или иной файл. Например, фотографию в формате .jpg, вы можете открыть в стандартном графическом редакторе Paint или в Photoshop, только вот функциональные возможности этих программ сильно отличаются. Это как проехать на автомобиле ВАЗ и BMW. Вот и судите, что вы можете сделать с фотографией, имея разные инструменты (программы) под рукой.

Мобильные приложения

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

По сравнению с традиционными приложениями, мобильные приложения относительно дешёвые. Многие из них стоят всего 30 рублей, а другие и вовсе бесплатные. Подключив ваше мобильное устройство к интернету, вы можете загружать приложения непосредственно на мобильное устройство. Или же можете скачать приложение на свой компьютер и затем передать его на мобильное устройство, через кабель или Bluetooth.

Главное, вы должны понимать, что от того какой программой вы пользуетесь, зависит конечный результат.

Друзья, поддержите нас! Поделитесь статьёй в социальных сетях:

Туториал для туториалов. Как написать пользовательскую документацию

Время на прочтение
12 мин

Количество просмотров 14K

Есть устоявшеёся мнение, что для хороших продуктов руководство пользователя не нужно. Очередной холивар на эту тему разгорелся в нашем рабочем чате. Я не до конца согласен с этим утверждением.

Хороший интерфейс действительно должен помогать пользователю быстро понять продукт и научиться им пользоваться. Как всегда есть пара НО.

Пользователи бывают разные. То есть они могут отличаться как по возрасту, отрасли и опыту, так и по количеству мотивации. Мотивация особенно касается b2b сервисов. Многие пользователи попадают в продукты, потому что «Начальник сказал».
Продукты бывают сложные. Быстро разобраться и понять все их фишки без документации сложно или невозможно.

Документация помогает пользователю решить проблему или помочь разобраться с особенностями и фишками продукта. В любой документации люблю раздел Tips&Tricks.

Что входит в пользовательскую документацию

Пользовательская документация — это не юридические документы. У них другие цели.

Пользовательская документация — это материалы, которые помогают пользователю использовать продукт на максималках.

Что еще можно отнести к пользовательской документации

Документация для разработчиков и администрированию: доки по API, инструкции по установке и администрированию. Но сейчас их касаться не буду.

В пользовательскую документацию я включаю:

Ответы на часто задаваемые вопросы (FAQ).
Руководство пользователя. Это самый жирный кусок из всей пользовательской документации. Здесь описывается весь интерфейс, только текстом.
Краткое руководство пользователя. Короткая презентация или документ для быстрого начала. Описывает базовые функции, возможности и советы для начала. Главное отличие от полного руководства — быстрее читаются, дают базовое представление о продукте и особенно помогают при внедрении b2b продуктов.
Описание отдельных фишек (Tips&Tricks). Чаще всего их делают в формате видеоуроков, но можно наткнуться и на текстовые.
Релизноуты. Считаю их важной частью пользовательской документации. И, говоря релизноуты, я имею ввиду не разовые, которые выкладываются в магазины приложений или к себе на сайт. А написанные раз в какой-то период. Можно раз в месяц. При работе над прошлым продуктом мы писали всё, что исправили или добавили за месяц. Хорошим тоном, на мой взгляд, будет писать самое важное.
Видеоуроки. Считаю их частью пользовательской документации, но это скорее вкусовщина, чем правило.

Почему это важно?

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

Если в вашей поддержке сидят операторы, то документация поможет им найти ответ на вопрос, если они не знают и быстро скопировать нужный текст для отправки. Или вообще отправить ссылку на кусок документации, который решает проблему пользователя.

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

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

Красоты B2B рынка

Прошлый продукт, над которым мы с командой работали, умел и в облако, и в on-premise.
С облаком все понятно. Динамическая документация на сайте или в другом сервисе. Документация для корпоративных заказчиков имеет определенные особенности.

Особенность #1: Корпорации любят печатную документацию. Очень сильно.
Мой знакомый сейлз любит рассказывать истории про это.

Резюме его историй:

Если вдруг что, отчитываться о покупке, установке и эксплуатации корпорации будут большими стопками документации.

Поэтому чем толще кипа бумаги — тем лучше.

Особенность #2: Нужно отдавать дополнительные пакеты документов.
В дополнительные пакеты документов входит: документация по установке вашего ПО и документацию по его администрированию, а может ещё что-то, если попросят.

Особенность #3: Документацию, которую вы отдаете корпоративному заказчику, нужно будет поддерживать отдельно.
Реальность работы с большими корпоративными заказчиками в том, что ваш продукт требует доработки для решения их задач. Всегда есть какие-то нюансы и дополнения. Поэтому отдавать им облачную документацию, чаще всего, не получится.

Особенность #4: Встречается реже, но тоже требует внимания. Если ваш продукт визуально кастомизируется (меняются цвета, меняется расположение кнопок), то для каждого заказчика с нестандартным интерфейсом нужно будет делать свою документацию. Это не правило, а скорее хороший тон и забота.

Где делать?

Много думал, долго смотрел. Переделывал наш гайд раз пять.

Когда искал, ставил для себя следующие задачи:

Документацию можно сделать динамической. То есть возможность грузить видео, гифки, делать кросс-ссылки.
Поддерживается базовое форматирование: заголовки, жирный, курсив, code, code block.
Возможность экспортировать в .pdf.

Небольшой совет

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

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

Какие вариант рассматривал:

Самописные.
Стоимость: может быть любой и измеряться в человеко-часах.
Плюсы: можно накрутить и наворотить, что по кайфу.
Минусы: долго, дорого, больно, потому что полноценный отдельный продукт, но для компаний больше 100 человек, может быть хорошим решением.
Google Docs.
Стоимость: Free
Плюсы: очень удобно работать с вёрсткой документа; привычный, при этом более простой интерфейс, относительно MS Docs; есть синхронизация с облаком; есть экспорт в .pdf.
Минусы: очень тяжело работать с визуальной частью — скринами; отношу в категорию не динамичных, так как выложить ссылочку на сайт на Google Doc конечно можно, особенно учитывая их последние апдейты, но это выглядит как-то не серьезно.
Notion.
Стоимость: можно Free, если работает один человек, а так от 8-10$ за человека.
Плюсы: очень удобно делать динамическую документацию, которую не стыдно выложить на сайт, по моим ощущениям; удобно работать в паре, есть все необходимое; можно вставить любое медиа, хоть ссылку, хоть видео, хоть схему из miro.
Минусы: не самый широкий спектр инструментов для работы с версткой; если неправильно сверстать, скопировать кусочек текста в другое место бывает накладно; не для всех пользователей привычная навигация по страницам.
Другие инструменты для wiki. Я смотрел на несколько вариантов wiki.js, Stonly 2, Dropbox Paper, Outline.

Смотрел давно, поэтому ничего вразумительно сказать не смогу. Помню, только что из всего выше, зацепил Dropbox и Wiki.js. В процессе написания этой статьи наткнулся ещё на один интересный сервис — GitBook. Он удовлетворяет всем моим запросам к подобным инструментам, но прошел мимо меня когда выбирал.
Figma.
Не пробовал, но хочу попробовать для ускорения работы именно с корпоративной документацией, есть у меня одна идея, как будет время попробую и расскажу.

С чего начать?

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

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

После того, как поняли зачем, накидайте план, а точнеё оглавление. План подразумевает последовательность, а оглавление позволяет вам писать не последовательно. Я писал непоследовательно. Сначала писал то, что помнил на память, потом все остальное.

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

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

Основные правила

Понятный и простой язык

Я не буду писать о важности соблюдения правил русского языка: орфографии, пунктуации. И не буду рассказывать «Как писать хорошо?». Я сам далеко не эксперт в этом вопросе, поэтому когда мне нужно написать хороший текст я всегда обращаюсь к заветам Ильяхова и сервисам Главред, Яндекс.Спеллер и LanguageTools.

Любой текст должен быть простым и понятным.

Самое главное всегда это помнить.

Из рекомендаций, которые могу дать я лично — отказываться от привычных определений и писать ещё проще.
Например, вместо «Кликнуть» писать «Нажмите», вместо «Свайпнуть» — «Провести». Так нужно делать, потому что среди пользователей могут быть люди, которые не знают даже базовых терминов.

Понятное и аккуратное форматирование

Я люблю типографику и когда все аккуратно. Поэтому случаются приступы гнева, когда документы плохо сверстаны. Считаю это важным, так как эти правила придумали не просто так, а чтобы было удобно для читателя.

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

Кавычки.
Все то ли ленятся, то ли не знают где на клавиатуре находятся наши кавычки. У меня есть предположение, что эта привычка пошла со школ, потому что руками мы пишем другие кавычки.

Основные кавычки оформляются елочкой «», внутренние кавычки оформляются лапками „“. Например, «Нажмите на вкладку „Контакты“ в левом верхнем углу», забугорные кавычки выглядят так «_».

Рекомендации по оформлению текста от Риановости
P.S. Иностранные названия в русском тексте кавычками не выделяются.
Тире и дефис.
Все знают про тире и дефис. Оказалось, что многие не знают про среднее тире.

Дефис (-) используется для присоединения частиц (что-то), для присоединения префиксов (по-братски), в словосочетаниях и сложносоставных словах (бизнес-ланч).
Среднее тире (–) применяется в числовом обозначении диапазонов и интервалов: 2011–2022, 11–12 ноября.
Длинное тире (—) используется для выделения прямой речи, указания маршрутов (Москва — Санкт-Петербург), между подлежащим и сказуемым.

Рекомендации по оформлению текста от Риановости

Оформление списков.
Существуют два вида списков: нумерованный и маркированный.

Маркированные списки выделятся буллитами, длинным тире или выключкой (реже всего встречается, сдвиг вправо, без символа), нумерованные списки выделяются числами.

Традиционный символ маркированного списка в русской типографике — тире, а не буллит. Говорят, что буллиты пришли к нам в месте с софтом от Microsoft. Мне нравятся буллиты и я чаще пользуюсь ими. Но они яркие и привлекают внимание. С одной стороны, это хорошо, с другой — с ними стоит быть осторожней. Если буллитов много, они могут перетянуть на себя внимание читателя.

Нумерованный список используется когда есть четкая последовательность пунктов. Когда последовательности нет — всегда маркированный.

Ещё один важный момент.
- Если пункт списка начинается с большой буквы, на конце всегда точка.
- Если пункт списка один или два слова и начинается с маленькой буквы, на конце запятая, в конце списка точка.
- Если пункт списка длинный и внутри пункта есть запятые, на конце ставим точку с запятой.

Оформление дат и чисел.
Если в тексте присутствуют даты, то лучше писать 15 мая 2021, а не 15.05.2021. Помогите пользователю думать только о важном.

Если есть числа, то их нужно тоже оформить правильно. Не 2221, а 2 221. Отделяйте тысячные, это очень сильно упрощает восприятие.
Вы или вы.
Мое стойкое мнение — если это не коммуникация с кем-то из государственной организации в переписке, всегда писать вы и ваш с маленькой буквы. Иначе выглядит, что вы кричите на пользователя, а на пользователя нельзя кричать.

В случае с гос. организациями все очень просто, я считаю, что если они узнают, что можно писать с маленькой, их мир рухнет.
Буква Ё.
С этой буквой у меня особые отношения. Исторически моя фамилия пишется через Ё, но из-за передергивания правил русского языка в советском союзе моя фамилия теперь пишется через Е. Поэтому я долгое время принципиально везде писал Е. Годы идут. Мозгов прибавилось. Теперь стараюсь писать Ё везде, где ей место. Так действительно проще воспринимать текст.
Эмодзи в тексте 🦄
По этому поводу много споров как у нас в команде, так и в кругах пишущих. Я придерживаюсь мнения, что эмодзи в тексте допустимы, но очень дозировано.

Я использовал эмодзи для визуального подчеркивания каких-то кнопок в интерфейсе.
Например: Нажмите на символ ⚙️ в правом верхнем углу.

Для поиска символов пользуюсь Glyphy.

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

Если ваш продукт международный

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

Удобная навигация

Нет единого мнения — как правильно. Если самопис, я рекомендую делать вертикальную навигацию слева. Такая часто встречается в технических документациях.

По структуре, на мой взгляд, можно выделить такие блоки:

Блок общего и важного.
- Описание вашего решения. Вдруг пользователь попал сначала на ваш гайд, а не на сайт.
- FAQ.
- Какие есть приложения, со ссылками на скачивания или как пользоваться, если это например веб-версия.
- Наши обновления.
Блок «Как начать». Сюда писать общие вещи, которые касаются всего сервиса. Особенно важный блок, если у вас мультиплатформенное решение.
Блок с руководством пользователя. Если у вас мультиплатформенное решение, то на каждую платформу лучше писать свое руководство. Можно объединять мобильные приложения и ПК версию. Так можно делать если нет глобальной разницы.

У нас, например, исторически разницы не было. Поэтому iOS и Android лежат на странице «Мобильные приложения». Но сейчас мы начали разделять, поэтому в будущем будет разделение на ОС.

Связность

Продукт — это всегда комплекс фич. И они часто между собой связаны. Если в одном месте упоминается другая фича, давайте ссылку на страницу или пункт.

Если хочется сделать по красоте, то можно внимательно изучить методологию Zettelkasten, например.

Удобный поиск

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

Вот как мы это в Notion решили.

Логичность

Всё, что вы пишите должно быть логичным.

Порядок элементов в тексте и интерфейсе должен быть одинаковым. Пользователь ломается, когда написано: «Нажмите на вторую вкладку „Контакты“», а вторая вкладка — «Чаты».
Или когда в интерфейсе элемент называется «Назначить админом», а написано «Назначить администратором».

Понятная визуалка

Этот пункт я бы хотел разбить на два блока: работа с медиа и работа с Step-by-Step.

Работа с медиа

Я сторонник динамичных гайдов. Когда есть .gif или видео презентация. Это помогает увидеть наглядно. Если есть возможность, наполняйте вашу документацию .gif.
С видео все сложнее. Оно требует дополнительного действия от пользователя — включить, плюс весит больше чем .gif. Поэтому видео использую редко. Чаще для каких-то больших блоков или полноценных видеоуроков.

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

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

Очень не люблю стрелочки. Считаю, что лучше выделить место геометрической фигурой и поставить номер шага. Но иногда стрелочки приемлемы, тут вкусовщина.

Из хороших приемов — блюрить лишнюю часть интерфейса или делать выделение лупой важной части.

Для работы со скриншотами я использую стандартный маковский редактор картинок, иногда Figma.

Step-by-step

Step-by-Step — это пошаговое описание всех действий, которые нужно выполнить пользователю, чтобы получить результат.

Искал хоть какую-то информацию про то, как пишутся такие штуки и ничего хорошего не нашел. Поэтому основываясь на здравом смысле, вывел для себя ряд правил:

Делать нумерованные списки. Если есть подпункты, то нумеровать их соответственно и делать сдвиг вправо 1.1, 1.2, 1.2.1 и тд.
Писать сначала «Что нажать», потом «Где нажать». Исхожу из простой логики — сначала нужно понять «Что искать» и только потом «Где искать».

Например: «Нажмите на кнопку „Включить“ в правом верхнем углу», а не «В правом верхнем углу нажмите на кнопку „Включить“».
Вставлять визуальные элементы для кнопок, особенно если они без подписи. Для этой истории приходится немного костылить, если делать это в том же Notion, но в Google Docs это делать проще. Использую стандартные эмодзи и сервис Glyphy.

Например: Нажмите на символ ⚙️ в правом верхнем углу.

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

Поддержка и послесловие

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

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

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

Раз в 3-6 месяцев заходить и перечитывать, лучше если это каждый раз будет делать новый человек. Это нужно делать по трем причинам:

1. Когда пишешь большие текстовые документы, глаз замыливается. Можно написать бред и после его не заметить.

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

3. Всегда есть что улучшить. Текст это такой же продукт.

Хочется верить, что эта статья сэкономит кому-то время, а кому-то поможет стать немного лучше.
Я не претендую на истину в последней инстанции. Описал свой опыт и мнение.

p.s. Пользовательская документация с которой все началось. Скажу сразу, там очень много чего можно и нужно улучшить. Бэклог по апдейту документации уже перевалил за 30 задач. Постепенно обновляем.

p.s.s. буду благодарен за конструктивный фидбек в комментариях и ещё больше, если поделитесь вашим опытом.

Источник

Виды
программ..

1.2.
Программы подразделяют на виды,
приведенные в табл.

Вид программы	Определение
Компонент	Программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса
Комплекс	Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса

1.2,1.3. (Измененная
редакция, Изм. № 1).

Виды программных продуктов

2.2. Виды программных
документов и их содержание.

Спецификация
— содержит состав программы и документации
на нее. Выполняется на стадии рабочего
проекта. Является обязательным документом
для комплексов и тех компонентов,
которые могут иметь самостоятельное
применение.
Ведомость держателей подлинников
(код вида документа — 05) — содержит
перечень предприятий, на которых хранят
подлинники программных документов.
Выполняется на стадии рабочего проекта.
Необходимость составления документа
на этапе утверждения технического
задания (по согласованию).
Текст
программы (код вида
документа — 12) — содержит запись программы
с необходимыми комментариями. Выполняется
на стадии рабочего проекта. Необходимость
— по согласованию.
Описание
программы (код вида
документа — 13) — содержит сведения о
логической структуре и функционировании
программы. Выполняется на стадии
рабочего проекта. Необходимость — по
согласованию.
Программа
и методика испытаний
(код вида документа — 51) — содержит
требования, подлежащие проверке при
испытаниях программы, а также порядок
и методы их контроля. Выполняется на
стадии рабочего проекта. Необходимость
— по согласованию.
Техническое
задание — содержит
назначение и область применения
программы, технические, технико-экономические
и специальные требования, предъявляемые
к программе, необходимые стадии и сроки
разработки, виды испытаний. Выполняется
на стадии технического задания и
является обязательным документом для
комплекса. Необходимость составления
технических заданий на компоненты
определяется по согласованию с
заказчиком.
Пояснительная
записка (код вида
документа — 81) — содержит схему алгоритма,
общее описание алгоритма и /или
функционирования программы, а также
обоснование принятых технических и
технико-экономических решений.
Выполняется на стадии эскизного и
технического проектов. Необходимость
— по согласованию.
Эксплуатационные документы —
содержит сведения для обеспечения
функционирования и эксплуатации
программы. Выполняются на стадии
рабочего проекта. Необходимость — по
согласованию для каждого документа
отдельно.

2.3. Виды
эксплуатационных документов и их
содержание

Ведомость эксплуатационных документов
(код вида документа — 20) — содержит
перечень эксплуатационных документов
на программу.
Формуляр (код вида документа —
30) — содержит основные характеристики
программы, комплектность и сведения
об эксплуатации программы.
Описание
применения (код
вида документа — 31) — содержит сведения
о назначении программы, области
применения, применяемых методах, классе
решаемых задач, ограничениях для
применения, минимальной конфигурации
технических средств.
Руководство
системного программиста
(код вида документа — 32) — содержит
сведения для проверки, обеспечения
функционирования и настройки программы
на условия конкретного применения.
Руководство
программиста (код
вида документа — 33) — содержит сведения
для эксплуатации программы .
Руководство
оператора (код вида
документа — 34) — содержит сведения для
обеспечения процедуры общения оператора
с вычислительной системой в процессе
выполнения программы .
Описание
языка (код вида документа
— 35) — содержит описание синтаксиса и
семантики языка.
Руководство
по техническому обслуживанию
(код вида документа — 46) — содержит
сведения для применения тестовых и
диагностических программ при обслуживании
технических средств.

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

Код вида документа	Вид документа	Стадии разработки
Эскизный проект	Технический проект	Рабочий проект
компонент	комплекс
—	Спецификация	—	—	2	1
05	Ведомость держателей подлинников	—	—	—	3
12	Текст программы	—	—	1	3
13	Описание программы	—	—	3	3
20	Ведомость эксплуатационных документов	—	—	3	3
30	Формуляр	—	—	3	3
31	Описание применения	—	—	3	3
32	Руководство системного программиста	—	—	3	3
33	Руководство программиста	—	—	3	3
34	Руководство оператора	—	—	3	3
35	Описание языка	—	—	3	3
46	Руководство по техническому обслуживанию	—	—	3	3
51	Программа и методика испытаний	—	—	3	3
81	Пояснительная записка	3	3	—	—
90-99	Прочие документы	3	3	3	3

Условные
обозначения:

1 —
документ обязательный;

2 —
документ обязательный для компонентов,
имеющих самостоятельное применение;

— —
документ не составляют.

2.2-2.5.
(Измененная редакция,
Изм. № 1).

Технические
условия разрабатывают на стадии «Рабочий
проект».

В общем случае каждый документ должен
иметь:

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

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

К основным функциям системы администрирования
относят:

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

Основные особенности современного
пользовательского интерфейса состоят
в следующем:

наличие механизмов управления окнами
использование готовых графических
символов (икон) для отображения
управляемых объектов
непосредственное манипулирование
графическими объектами и окнами
посредством мыши
объектно и проблемно-ориентированное
проектирование диалоговых систем.

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

Обучение представляет собой процесс
обеспечения и сопровождения обучаемого
персонала.

Правила оформления лабораторных
работ.

Общие положения

В отчет по лабораторной работе должны
быть включены следующие пункты:

— титульный лист;

— цель работы;

— краткие теоретические
сведения;

— описание
экспериментальной установки и методики
эксперимента;

— экспериментальные
результаты;

— анализ результатов
работы;

— выводы.

Требования к содержанию отдельных
частей отчета по лабораторной работе

В нижнем поле листа указывается место
выполнения работы и год ее написания
(без слова год).

Анализ результатов работы. Раздел отчета
должен содержать подробный анализ
полученных результатов.

Выводы. В выводах кратко излагаются
результаты работы.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Заключение

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

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

Источник

Документ «Руководство пользователя»

РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: <…>.

УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.

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

Структура документа:
1. Введение
1.1 Область применения
1.2 Краткое описание возможностей
1.3 Уровень подготовки пользователя
1.4 Перечень эксплуатационной документации
2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
2.1 Виды деятельности, функции
2.2 Программные и аппаратные требования к системе
3 ПОДГОТОВКА К РАБОТЕ
3.1 Состав дистрибутива
3.2 Запуск системы
3.3 Проверка работоспособности системы
4 ОПИСАНИЕ ОПЕРАЦИЙ
4.1 Наименование операции
4.2 Условия выполнения операции
4.3 Подготовительные действия
4.4 Основные действия
4.5 Заключительные действия
4.6 Ресурсы, расходуемые на операцию
5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ
6 РЕКОМЕНДАЦИИ ПО ОСВОЕНИЮ

УКАЗАНИЯ ГОСТ:
Документ содержит разделы:
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.

1. Введение

1.1 Область применения

ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа «Техническое задание, п.п.2.1».

1.2 Краткое описание возможностей

ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа «Описание автоматизируемых функций, п.п.2.».

1.3 Уровень подготовки пользователя

ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа «Техническое задание, п.п.4.1.2 Требования к численности и квалификации персонала системы»

1.4 Перечень эксплуатационной документации

ПРИМЕР СОДЕРЖАНИЯ:
Перечень эксплуатационных документов, с которым необходимо ознакомиться:
— АС Кадры. «Руководство администратора»;
— АС Кадры. «Руководство пользователя»;
— т.д.
— пр.;

2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе «Назначение и условия применения» указывают:
1) виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
2) условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

ПРИМЕР СОДЕРЖАНИЯ:

2.1 Виды деятельности, функции

ПРИМЕР СОДЕРЖАНИЯ:
АС Кадры предназначена для автоматизации следующих видов деятельности:
Наполнение раздела можно взять в документе «Описание автоматизируемых функций, раздел ЦЕЛИ АС И АВТОМАТИЗИРУЕМЫЕ ФУНКЦИИ».

2.2 Программные и аппаратные требования к системе

ПРИМЕР СОДЕРЖАНИЯ:
Пример требований к программному обеспечению приведен в документе «Пояснительная записка, п.п.3.10».
Пример требований к аппаратному обеспечению приведен в документе «Техническое задание, п.п.4.3.5».

3 ПОДГОТОВКА К РАБОТЕ

УКАЗАНИЯ ГОСТ:
В разделе «Подготовка к работе» указывают:
1) состав и содержание дистрибутивного носителя данных;
2) порядок загрузки данных и программ;
3) порядок проверки работоспособности.

3.1 Состав дистрибутива

ПРИМЕР СОДЕРЖАНИЯ:
В состав дистрибутива АС Кадры входит:
— СУБД Oracle 10.2g;
— Приложение установки базы данных;
— Серверная часть Windows приложения АС Кадры;
— Клиентская часть Windows приложения;
— т.д.;
— пр.

3.2 Запуск системы

ПРИМЕР СОДЕРЖАНИЯ:
Предварительно необходимо выполнить установку системы. Информацию об установке системы можно получить в документе РД И3(А) АС Кадры, который входит в состав проектной документации.
1. Для того, чтобы запустить АС Кадры, откройте папку, в которую была установлена программа, и запустите файл kadry.exe.
2. В открывшемся окне заполните следующие поля в области окна Общие параметры:
— Логин — логин (логическое имя) пользователя;
— Пароль — пароль для входа в систему;
3. т.д.
пр.

3.3 Проверка работоспособности системы

ПРИМЕР СОДЕРЖАНИЯ:
Программное обеспечение работоспособно, если в результате действий пользователя, изложенных в п.п.3.2, на экране монитора отобразилось главное окно клиентского приложения без выдачи пользователю сообщений о сбое в работе.

4 ОПИСАНИЕ ОПЕРАЦИЙ

УКАЗАНИЯ ГОСТ:
В разделе «Описание операций» указывают:
1) описание всех выполняемых функций, задач, комплексов задач, процедур;
2) описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.
Для каждой операции обработки данных указывают:
1) наименование;
2) условия, при соблюдении которых возможно выполнение операции;
3) подготовительные действия;
4) основные действия в требуемой последовательности;
5) заключительные действия;
6) ресурсы, расходуемые на операцию.

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

4.1 Наименование операции

ПРИМЕР СОДЕРЖАНИЯ:
Просмотр справочной информации.

4.2 Условия выполнения операции

ПРИМЕР СОДЕРЖАНИЯ:
Приложение запущено, успешно функционирует, не выполняет никакх операций, блокирущих доступ к пунктам меню.

4.3 Подготовительные действия

ПРИМЕР СОДЕРЖАНИЯ:
Отсутствуют.

4.4 Основные действия

ПРИМЕР СОДЕРЖАНИЯ:
Открыть пункт меню «Помощь», выбрать раздел «Справка». Появится всплывающее окно, содержащее разделы со справкой.

4.5 Заключительные действия

ПРИМЕР СОДЕРЖАНИЯ:
После завершения работы со справочной информацией, закрыть вплывающее окно со справкой.

4.6 Ресурсы, расходуемые на операцию

ПРИМЕР СОДЕРЖАНИЯ:
Отсутствуют.

5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ

УКАЗАНИЯ ГОСТ:
В разделе «Аварийные ситуации» указывают:
1) действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств;
2) действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных;
3) действия в случаях обнаружении несанкционированного вмешательства в данные;
4) действия в других аварийных ситуациях

ПРИМЕР СОДЕРЖАНИЯ:
При сбое в работе аппаратуры восстановление нормальной работы системы должно производиться после:
— перезагрузки операционной системы;
— запуска исполняемого файла системы;

При ошибках в работе аппаратных средств (кроме носителей данных и программ) восстановление функции системы возлагается на ОС.
При ошибках, связанных с программным обеспечением (ОС и драйверы устройств), восстановление работоспособности возлагается на ОС.
При неверных действиях пользователей, неверных форматах или недопустимых значениях входных данных, система выдает пользователю соответствующие сообщения, после чего возвращается в рабочее состояние, предшествовавшее неверной (недопустимой) команде или некорректному вводу данных.

6 РЕКОМЕНДАЦИИ ПО ОСВОЕНИЮ

УКАЗАНИЯ ГОСТ:
В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

ПРИМЕР СОДЕРЖАНИЯ:
Для успешного освоения приложения АС Кадры необходимо иметь навыки работы с ПК и изучить следующее:
— Нормативно-правовую базу по вопросам управления государсвенными кадрами;
— Раздел «Описание процесса деятельности» документа «Пояснительная записка (Технический проект)»;
— Раздел «Описание автоматизируемых функций» документа «Пояснительная записка (Технический проект)»;
— Настоящее «Руководство пользователя».

Контрольный пример работы с системой
Ниже рассмотрен пример работы с системой, начиная с ее запуска и заканчивая оформлением документов:
1. Запустите систему.
2. т.д.
3. пр.

Источник