Инструкция для пользователя пример - Kompot.top

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

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

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

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

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

Введение.
Назначение и условия применения.
Подготовка к работе.
Описание операций.
Аварийные ситуации.
Рекомендации по освоению.

1. Введение

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

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

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

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

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

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

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

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

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

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

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

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

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

Internet Explorer (входит в состав операционной системы Windows);
Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД.

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

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

Необходимо зайти на сайт ИАС КХД ias-dwh.ru.
Во время загрузки в появившемся окне «Предупреждение о безопасности», которое будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator» …’ Нажимаем на кнопку «Да».
После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK.

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

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

Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск».
Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее».
Убедиться, что в окне открылось приложение Oracle Discoverer Plus.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Компьютер пользователя подключен к корпоративной сети.
Портал ИАС КХД доступен.
ИАС КХД функционирует в штатном режиме.

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

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

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

На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».

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

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

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

15-30 секунд.

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

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

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

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

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

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

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

РД 50-34.698-90 Руководство пользователя (пример формирования). Oracle Discoverer

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. настоящего документа.

Источник

Примеры и рекомендации удобных инструкций

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

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

Снова здравствуй, уважаемый хабралюд!

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

Всем, кому интересно, прошу под хабракат.

KISS

Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.

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

1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4. Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5. Психологический момент — инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому — НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!

Пример инструкции для пользователей

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

Clear screen/clear desk

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

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

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

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

Источник

Руководство пользователя нужно всем IT-продуктам — новым и давно выпущенным. Куда нажать, чтобы всё заработало? Как пользоваться программой после масштабного обновления? Знакомые вопросы для любого юзера.

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

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

📌 Руководство пользователя ещё называют инструкция пользователя, документация, хелп или юзер-гайд (user guide). Это справочная цифровая библиотека, по которой можно изучать программу. Руководство пользователя входит в состав технической документации и разрабатывается техническим писателем и продуктовой командой.

Документация продуктов бывает разной, как и сами продукты. У них отличаются цели и аудитории 👇

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

⚙️ Пошаговое руководство или «Быстрый старт»

Общее описание продукта — рассказывает, как им пользоваться

Для кого. Для тех, кто делает первые шаги в использовании продукта
Цель и польза. Знакомство с основными функциями продукта, чтобы дальше использовать его самостоятельно
Форматы публикации. Текст и видеотуториалы

Источник: Segnetics

⚙️ Справочное руководство

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

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

Хелп WEEEK

⚙️ Руководство по устранению неисправностей

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

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

Источник: ELTEX

⚙️ Руководство для администраторов

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

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

Источник: VK WorkSpace

⚙️ API-документация

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

Для кого. Для внутреннего использования с фокусом на потребностях разработчиков
Цель и польза. API-документация нужна для успешной интеграции API в проекты и полноценного использования его функций внутри системы
Форматы публикации. Текст

Источник: REST API GitHub

Руководства такие разные, но у них много общего — структура, язык, подход к написанию.

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

Как создать руководство пользователя. Опыт WEEEK

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

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

Шаг 1. Определение содержания

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

К примеру, руководство пользователя в WEEEK содержит подробную информацию о пяти главных сервисах: Задачах, Базе знаний, CRM, Пользователях и Аналитике.

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

Руководство пользователя, определение содержания

Слева как раз содержание руководства: главные его части

Наш хелп — справочное руководство пользователя. Мы пишем его вместе с разработчиками и продуктовой командой: они обладают практической информацией, без которой наш хелп был бы просто теорией. Советую перед определением содержания, подготовкой структуры и прочих нюансов изучить похожие продукты. Посмотри, что и как они подсвечивают в своих хелпах и выдели аналогичные топики, которые можно взять для себя. Например, мы в WEEEK изучали хелпы Notion, Trello и Asana

Наш хелп тут

Шаг 2. Структурирование материала

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

Здесь нужно расширить содержание сервиса. Как это сделать? Разбить составные части продукта на более мелкие — определить разделы и статьи, которые расскажут про каждый из них.

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

💡 При визуализации лучше дать каждому блоку свой цвет — это поможет ориентироваться в структуре и видеть картину целиком:

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

Построение схемы в FigJam

Главное договориться о цветах визуализации!

Шаг 3. Написание и форматирование

Написание статей можно поставить на поток. Достаточно подготовить шаблон и собирать тексты как конструктор:

У нас структура текста документации создана в FigJam

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

Каждая колонка на Канбан-доске может относиться к разделам хелпа:

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

Структура на доске повторяет структуру в схеме. Но с доской проще работать

То же самое касается и самого написания статей.

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

Ответственный перемещает задачу по доске. Когда текст готов, то его переносят в колонку «На проверке» — и так далее. Это делает процесс работы прозрачным.

Мы используем итеративную систему: написали статью, опубликовали её — статус у карточки на Канбане поменялся. При необходимости можно обратно вернуть её в работу. Каждая карточка привязывается к определённой статье. Ещё в карточках хранится вся информация о текстах — кто автор, ТЗ, прочие комментарии, когда дедлайн, какой приоритет и так далее

Наш хелп

Рукия Багаудин, технический писатель WEEEK

Руководство пользователя, связи между частями структуры

На Канбан-доске удобно декомпозировать большие задачи. Так можно повторить структуру руководства со схемы — все внутренние подразделы привязаны к родительскому. Они образуют одну сущность, будут храниться вместе и не потеряются:

Глава руководства — задача. Статьи — подзадачи

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

Наш хелп

Шаг 4. Ревизия и корректура

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

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

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

Наш хелп

Шаг 5. Публикация и актуализация

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

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

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

Один источник информации про обновления. Это может быть общий документ в корпоративной базе знаний или отдельный чат
Система приоритизации, выработанная вместе с продуктовой командой. Не получится обновлять все тексты разом, и будут обновления, о которых надо написать в первую очередь. Решить, что сейчас в приоритете, можно только с продакт-менеджером или владельцем продукта

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

Наш хелп

Тезисы вместо всей статьи

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

Источник

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

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

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

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

Какие ГОСТ используются при написании руководства пользователя приложения

Существует две серии (набора) стандартов, которые регламентируют набор создаваемых документов и правила их оформления при разработке автоматизированных систем, комплексов и программного обеспечения:

ГОСТ 34 — Автоматизированные системы
ГОСТ 19 — Единая система программной документации (ЕСПД)

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

ГОСТ 34 главным образом определяет комплектность, виды, структуру и содержание создаваемых документов.

ГОСТ 19 в большей степени определяет правила оформления документов.

Поэтому, на практике часто используются сразу оба этих ГОСТа.

Руководство пользователя — основной документ для конечного пользователя

Если говорить именно о документации для конечного пользователя системы, то из перечня описываемых в ГОСТ 34 документов нас интересует «Руководство пользователя». В ГОСТ 19 аналогичный по смыслу документ называется «Руководство оператора», но для программного обеспечения чаще используется именно первый вариант.

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

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

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

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

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

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

Dr.Explain упрощает создание руководства пользователя по ГОСТ

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

В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:

Наличие обязательных разделов документа “Руководство пользователя” [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их содержанию.
Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
Параметры печатных страниц документа и расположение основных элементов на них [ГОСТ 19.106-78].
Структуру и оформление колонтитулов [ГОСТ 19.106-78].
Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы [ГОСТ 19.106-78].
Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].

Управление функцией поддержки ГОСТ для проекта доступно в Настройках проекта в разделе Общие.

При включенном режиме поддержки ГОСТ для проекта соответствующие пользовательские настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.

Для выходных форматов HTML и CHM будут использоваться пользовательские настройки вне зависимости от активности режима поддержки ГОСТ. Это снимает ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.

Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.

Важно: Функция поддержки ГОСТ доступна в Dr.Explain только в русскоязычной версии интерфейса. Язык интерфейса программы выбирается в меню Настройки\Выбор языка программы (Options\Application language).

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

Для создания нового руководства пользователя по требованиям ГОСТ 34 в программе Dr.Explain можно использовать команды меню Файл \ Создать локальный проект — Руководство пользователя по ГОСТ 34 или Файл \ Создать общий проект на tiwri.com — Руководство пользователя по ГОСТ 34

или аналогичные кнопки на стартовом экране приложения.

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

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

Настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

Приведение существующей пользовательской документации в соответствие с требованиями ГОСТ

Также программа Dr.Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ.

Если исходная документация еще не ведется в Dr.Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу. Dr.Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл.

Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом.
Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст их. Остальные существующие разделы, наличие которых не регламентировано ГОСТами, будут перенесены в скрытый от экспорта раздел “Старое дерево разделов”.

Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости.

Как и в первом случае настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

Создайте документацию, соответствующую ГОСТ 19 и ГОСТ 34 в Dr.Explain бесплатно

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

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

Источник

УТВЕРЖДАЮ

должность _________________________

___________________________________

подпись _______________________ ФИО

«____»_______________________ 20__ г.

наименование вида ИС

Сокращенное наименование ИС

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

А. В.ХХХХХ-ХХ ХХ (согласно ГОСТ 19.103-77)

СОГЛАСОВАНО

должность _______________________

подпись___________________ ФИО

«____»__________________ 20__ г.

РАЗРАБОТЧИК

должность _______________________

подпись___________________ ФИО

«____»___________________ 20__ г.

Город 20__

Содержание

1 Введение 3

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

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

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

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

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

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

2.2 Условия применения Портала 4

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

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

3.2 Порядок загрузки данных и проверка работоспособности 5

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

4.1 Описание операции 1 6

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

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

7 Термины и сокращения 9

Введение
1. Область применения

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

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

Описание возможностей АС.

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

Основные требования к уровню подготовки пользователя для работы с АС.

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

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

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

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

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

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

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

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

Порядок загрузки данных и проверка работоспособности

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

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

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

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

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

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

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

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

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

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

Термины и сокращения

Термин	Полная форма

СОСТАВИЛИ

Наименование организации, предприятия	Должность исполнителя	Фамилия, имя, отчество	Подпись	Дата

СОГЛАСОВАНО

Наименование организации, предприятия	Должность исполнителя	Фамилия, имя, отчество	Подпись	Дата

Источник