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

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

Приятного чтения.

Если перед вами стоит вопрос – нужно ли вашему продукту пользовательское руководство, то отвечу сразу – да, нужно. Почему? На это есть две причины:

1. Качественная документация повышает лояльность клиента и ценность продукта в целом.

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

2. Руководство пользователя экономит время и силы техподдержки.

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

А теперь к советам!

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

Прежде чем начинать писать руководство пользователя нужно ответить на несколько вопросов. — Для кого вы пишите? Кто будет пользоваться файлом справки? (ваша целевая аудитория)

— Где скорее всего пользователи будут прибегать к документации? (дома, на работе, в машине)

— Насколько объективно сложен для понимания продукт и как часто пользователь будет обращаться к документации?

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

(Для изложения лучше всего выбрать нейтрально-формальный стиль)

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

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

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

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

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

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

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

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

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

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

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

Как ее сделать? Смотрите ниже.

Контент

И так, мы создали «каркас» нашей документации, но чтобы руководство стало полезным нужно наполнить её компетентной информацией.

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

1. Понятность.

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

2. Наглядность.

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

3. Видео.

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

Но как добавить в документацию видео? Смотрите ниже.

Больше советов!

Когда документация будет готова, чтобы она стала «полноценной» её нужно опубликовать. Иначе какой от неё толк, если клиент не может её прочитать. У «юзера» всегда должен быть доступ к документации, и не важно где он. Такую потребность легко закрывают три формата: HTML, PDF и CHM.

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

Выложите руководство на сайт в формате HTML, чтобы клиент мог обратиться к документации, даже не работая с программой. Кроме того, документация, выложенная на сайт, повышает SEO факторы сайта.

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

Но помните, что после публикации документации, придется иногда её обновлять.

Инструменты

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

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

Dr.Explain – программа для создания руководств пользователя для ПО, web-сервисов и баз знаний.

Благодаря «доктору» вы сможете опубликовать и обновлять документацию в востребованных форматах (CHM; HTML; PDF; DOC), не выходя из программы.

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

Импортируйте в программу заранее написанные фрагменты документации.

Вы сможете создать контекстно-зависимую документацию, настроить визуальный стиль руководства, добавить в него видео и многое другое!

Какой можно сделать вывод

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

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

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

Спасибо за внимание!

Со всеми возможностями Dr.Explain можно ознакомиться здесь:

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

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

• браузер Internet
  Explorer
  3.3;

• операционная
  система Microsoft
  Windows
  95;

• процессор с
  тактовой частотой 100 МГц;

• размер ОЗУ 8 Мб;

• около 6 Мб свободного
  дискового пространства.

Файлы электронного
учебного пособия скомпилированы с
помощью программы htm2chm, поэтому для
начала работы нужно открыть файл
ЭУП_Офисное программирование. chm. После
загрузки на экране появится главная
страница пособия.

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

Рис. 1 Глава 1.3.
Изменение порядка выполнения операторов..
Применение кнопок «Вперед»/»Назад»

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

Страница «Глоссарий»
содержит основные понятия и определения
к ним.

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

Рис. 2. Тест

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

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

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

Глава 3. Краткое содержание электронного учебного пособия «Офисное программирование»

3.1 Типы данных, условные операторы и массивы vba

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

С помощью VBA можно
изменять внешний вид или способ применения
имеющихся средств приложения, а также
добавлять свои, совершенно новые
возможности.

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

Microsoft создала VBA и
обеспечила поддержку VBA во всех главных
приложениях Office: Word, Excel, Access и PowerPoint.

Объектно-ориентированное
программирование.

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

Язык VBA является
объектно-ориентированным. Это значит,
что многие его команды имеют особенный
формат. Типичная команда VBA имеет вид:
<Объект>.<Объект, входящий в первый
объект>.<…>.<Тот объект, с которым
нужно произвести действие>.<собственно
действие>

Иными словами,
каждая команда пишется как бы с «конца»:
вначале определяется то, над чем надо
произвести действие, – объект, а затем
само действие – метод. Разделителями
компонентов команды служат знаки
«точка».

Пример:
Application.activDocument.PageSetup.Orientation=wdOrientLandscape —
Эта команда устанавливает альбомную
ориентацию листа в документе.

Типы данных.

Тип данных – это
термин, относящийся к определенным
видам данных, которые VBA сохраняет и
которыми может манипулировать.

Любое определение
типа задает:

• область возможных
значений типа;

• структуру
организации данных;

• операции,
определенные над данными этого типа.

VBA разделяет
обрабатываемые данные на числа, даты,
строки, логические значения и объекты.

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

1) активизировать
любое приложение пакета MS Office (Word, Excel);

2) выполнить команду
меню: Сервис <> Макрос <> Редактор
Visual Basic.

Или:

1) активизировать
любое приложение пакета MS Office (Word, Excel);

2) нажать комбинацию
клавиш Alt+F11.

И в том, и в другом
случае откроется редактор VBA (рис. 3).

Рис. 3. Стартовое
окно редактора VBA

В левой части окна
редактора появляется строение
разрабатываемого проекта (аналог с
Проводником). Необходимо обратить
внимание на два главных объекта окна:
Normal и Project (Операции).

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

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

Операторы.

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

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

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

Простейшими
VBA-операторами изменения порядка
выполнения кода являются операторы If
… Then и If … Then … Else.

Оператор If … Then
позволяет выбрать единственную
альтернативную ветвь кода в процедуре
или функции.

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

VBA, как и многие
языки программирования, имеет условный
оператор перехода для использования в
случаях, когда необходимо выбирать из
большего количества различных ветвей
кода: оператор Select Case. Данный оператор
работает во многом так же, как и оператор
If. Ключевые слова Select Case используются
со многими операторами Case, где каждый
оператор Case проверяет появление другого
условия и выполняется только одна из
ветвей Case. Ветвь Case может содержать
один, несколько или ни одного оператора
VBA.

Циклы.

Процесс выполнения
всех операторов, заключенных в структуру
цикла, один раз называется итерацией
(iteration) цикла. Некоторые структуры цикла
организуются так, что они всегда
выполняются заданное количество раз.
Структуры цикла, всегда выполняющиеся
заданное количество раз, называются
циклами с фиксированным числом итераций
(fixed iteration). Другие типы структур цикла
повторяются переменное количество раз
в зависимости от некоторого набора
условий. Поскольку количество раз
повторений этих гибких структур цикла
является неопределенным, такие циклы
называются неопределенными циклами
(indefinite loops).

Цикл For…Next
используется, когда необходимо повторить
действие или ряд действий заданное
количество раз, известное до начала
выполнения цикла.

Второй цикл For,
который имеется в VBA, – это цикл For Each …
Next. В отличие от цикла For…Next, цикл For Each
… Next не использует счетчик цикла. Циклы
For Each … Next выполняются столько раз,
сколько имеется элементов в определенной
группе, такой как коллекция объектов
или массив. Другими словами, цикл For Each
… Next выполняется один раз для каждого
элемента в группе.

Массивы.

Массив (array) – это
коллекция переменных, которые имеют
общие имя и базовый тип. Массив является
удобным способом хранения нескольких
связанных элементов данных. Все элементы
данных, сохраняемых в массиве, должны
иметь один и тот же тип.

Наименее сложный
массив – это просто список элементов
данных; такого рода массив называется
простым, или одномерным, массивом.
Подобный массив можно представить в
виде очереди, где каждому элементу
очереди присваивается не только
порядковый номер (место в очереди), но
и его конкретное значение (имярек).

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

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

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

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

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

Выбор размера
массива может быть затруднен, если
неизвестно, сколько данных будет введено
в массив, или если объем данных, собираемых
для массива, значительно меняется. Для
подобных ситуаций VBA поддерживает особый
тип массивов, называемый динамическим
(dynamic) массивом.

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

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

Процедуры VBA бывают
двух типов:

• процедуры
обработки событий;

• общие процедуры.

Имя процедуры
обработки события, связанного с элементом
управления, состоит из имени элемента
управления, символа подчеркивания и
имени события, например Закрытъ_ click –
процедура обработки нажатия кнопки
Закрыть в форме.

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

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

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

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

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

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

• #
• #
• #

  21.04.2019184.83 Кб1013.doc

• #
• #
• #
• #
• #
• #
• #
• #

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

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

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

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

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

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

1. Введение

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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