Что такое руководство пользователя. Методика и стиль изложения руководства пользователей

Вам понадобится

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

Инструкция

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

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

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

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

руководств по ЕСПД и IEEE Std 1063-2001 с учетом «манифеста Кагарлицкого». Показано, что обобщенная структура руководства пользователя, собранная согласно требованиям «устаревших» ГОСТов 19-й системы, существенно превосходит структуру руководства, рекомендуемую суперсовременным IEEE Std 1063-2001. Редакция от 20.06.2018.

Как писать руководство пользователя? Часть I - обобщенная структура руководства пользователя по ГОСТам 19-й системы и сравнительный ее анализ с рекомендациями IEEE Std 1063-2001

Создан 11.02.2005 11:14:22

Когда умирает надежда, приходит отчаяние.

Мудрая латинская поговорка

Как писать руководство? Создать древовидную руководства пользователя и заполнить ее разделы. И вся любовь.

Где взять структуру разделов руководства пользователя? С руководствами на (руководство по эксплуатации по) и на () все более или менее ясно. А вот сам документ «Руководство пользователя» программы в ГОСТах 19-й системы отсутствует как класс.

Каким содержимым наполнять разделы руководства пользователя? Как быть? Главное - не отчаиваться.

Цели и задачи статьи

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

проанализировать существующие и по разработке, выявить достоинства и недостатки каждого документа по отдельности;
вывести некую обобщенную структуру руководства пользователя по ГОСТам 19-й системы из имеющегося набора эксплуатационных программных документов;
сравнить ее со структурой, рекомендованной IEEE Std 1063-2001;
а все прочие задачи перекочевали во 2-ю часть статьи...

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

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

Подарите ребенку незнакомую ему электронную игрушку. Перечень вопросов будет примерно таким (если сразу же не разломает):

а что это;
а что им можно делать;
а что им нельзя делать (у особо одаренных);
а что надо, чтобы оно работало;
а что там у него внутри (у детей, склонных к глубокому);
а как его настроить, чтобы работало так, как я хочу;
а как его проверить, работает оно или не работает;
а что и где надо нажимать;
а что оно еще может делать;
а что оно говорит, если что-то не так нажимаешь?

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

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

Располагаем:

«метагайдом» Кагарлицкого;
суперсовременным IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
классическими отечественными ГОСТами 19-й системы, включающим в себя перечисленные ниже документы «описательного» характера:

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

Возможно, существуют и иные документы, но автору, основательно порывшемуся в рунетовской свалке, ничего более подходящего заполучить пока не удалось. Яндекс обнаружил в своих недрах еще одну страничку с названием «Как сделать хорошее руководство пользователя», автор которой именует себя на американЬ ский манер (типа John P. Morgan). Двухстраничное «наставление» с радостными возгласами было немедленно отправлено в корзину.

Манифест Кагарлицкого

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

(цитаты из манифеста Кагарлицкого)

Мы стремились свести в единую систему всю совокупность типовых требований, которые должны, с нашей точки зрения, предъявляться к технической документации: руководствам, справочникам и т.д. При этом мы основывались на стандартах(!!!) ГОСТ , стандартах компании Microsoft, опыте наших сотрудников и других разработчиков технической документации.

Начало обнадеживающее.

В состав технической документации входят две стержневые части, которые мы будем называть соответственно руководством пользователя и справочником пользователя, или коротко: руководством и справочником (по аналогии с английскими словосочетаниями User"s Guide и User"s Reference). Они могут быть оформлены в виде отдельных документов (для крупных программных продуктов), а могут, напротив, существовать в интегрированном виде. Между ними даже может не быть четкой границы: единый текст способен совмещать в себе черты руководства и черты справочника.

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

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

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

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

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

Жаль... А так все хорошо начиналось. Со «стандартов ГОСТ » - «стандартов » - простим г-на Кагарлицкого за тавтологию. Только вот решения первой задачи, поставленной автором настоящей статьи, в семидесятидвухстраничном манифесте (Arial"ом 12pt) нет. Уважаемый автор манифеста лишь поставил нам задачу . Что ж, нет пророка в своем отечестве. Может, есть пророк в отечестве буржуйском?

Руководство пользователя по IEEE Std 1063-2001 «IEEE Standard for Software User Documentation»

Забугорный «пророческий» документ IEEE Std 1063-2001 (IEEE в простонародье - «ай-яй-яй») в подразделе 1.2 (Puprose) содержит такую строчку:

This revision provides requirements for the structure, information content, and format of both printed and electronic documentation.

В авторском понимании назначение (намерение, цель, замысел, стремление) документа IEEE Std 1063-2001 состоит в «обеспечении требований к структуре, информационному наполнению, (оформлению) как, так и печатной пользовательской документации по программным средствам». Что ж, подходяще. Какую же структуру руководства пользователя предлагает IEEE Std 1063-2001?

Структура руководства пользователя по IEEE Std 1063-2001

Опциональная типовая структура руководства пользователя содержится в таблице из раздела Structure of software user documentation документа IEEE Std 1063-2001:


Identification data (package label/title page)
Table of contents		Yes, in documents of more than eight pages after identification data
List of illustrations


Concept of operations
		Yes (instructional mode)
		Yes (reference mode)

		Yes, if documentation contains unfamiliar terms
Related information sources
Navigational features
		Yes, if documents of more than 40 pages
Search capability		Yes, in electronic documents

For purposes of this standard, the following non-mandatory nomenclature is used for the structural parts of software user documentation. A printed document is structured into logical units called chapters, subdivided into topics, which may be subdivided into subtopics, and printed on physical units called pages.

Здорово. IEEE Std 1063-2001 предлагает «все взять и поделить» - разбить разделы руководства на главы, топики, субтопики и т.д. И наступит всем счастье.

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

Introduction

Какие сведения должны быть изложены в разделе Introduction согласно IEEE Std 1063-2001? А вот какие

The introduction shall describe the intended audience, scope, and purpose for the document and include a brief overview of the software purpose, functions, and operating environment.

Что ж, замечательно. Структура подразделов Introduction начинает как-то вырисовываться.

Information for use of the documentation

The documentation shall include information on how it is to be used (for example, help on help), and an explanation of the notation (a description of formats and conventions-see 5.8). At least one document in a document set shall identify all documents in the set by title and intended use, including recommendations on which members of the audience should consult which sections of the documentation. In document sets comprising many volumes or products, this information may be provided in a separate "road map" or guide to the document set. Documentation may include identification and discussion of notable changes from the previous version of the document set and the software.

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

Concept of operations

Documentation shall explain the conceptual background for use of the software, using such methods as a visual or verbal overview of the process or workflow; or the theory, rationale, algorithms, or general concept of operation. Explanations of the concept of operation should be adapted to the expected familiarity of the users with any specialized terminology for user tasks and software functions. Documentation shall relate each documented function to the overall process or tasks. Conceptual information may be presented in one section or immediately preceding each applicable procedure.

Концептуальная информация безусловно важна.

Procedures

Task-oriented instructional mode documentation shall include instructions for routine activities that are applied to several functions:

Software installation and de-installation, if performed by the user

Orientation to use of the features of the graphical user interface (see 5.6)

Access, or log-on and sign-off the software

Navigation through the software to access and to exit from functions

Data operations (enter, save, read, print, update, and delete)

Methods of canceling, interrupting, and restarting operations

These common procedures should be presented once to avoid redundancy when they are used in more complex functions.

И пошла конктерика. Молодцы, буржуи!

Information on software commands

Documentation shall explain the formats and procedures for user-entered software commands, including required parameters, optional parameters, default options, order of commands, and syntax. Documentation may be provided on the development and maintenance of macros and scripts. Reference mode documentation shall contain a reference listing of all reserved words or commands. Examples should illustrate the use of commands. Documentation shall explain how to interrupt and undo operation during execution of a command and how to restart it, if possible. Documentation shall describe how to recognize that the command has successfully executed or abnormally terminated.

Error messages and problem resolution

Documentation should address all known problems in using the software in sufficient detail such that the users can either recover from the problems themselves or clearly report the problem to technical support personnel. Reference mode documentation shall include each error message with an identification of the problem, probable cause, and corrective actions that the user should take. A quick reference card may address error messages by referring the user to more detailed reference documentation. The documentation on resolving problems shall also include contact information for reporting problems with software or its documentation and suggesting improvements.

Выводы по IEEE Std 1063-2001

Но счастье оказалось неполным... Структура разделов первого уровня руководства показана в таблице явно. А дальше - «милый мой, хороший, догадайся сам» («догадайся, мол, сама»). IEEE Std 1063-2001, конечно, «provides requirements for the structure», но не предлагает явной структуры руководства пользователя до рекомендованного ГОСТ 2.105 четвертого уровня вложенности.

Рекомендации типа «Documentation shall explain...», «Examples should illustrate...», «Documentation shall describe...» и им подобные, безусловно, проверены временем. В руководстве пользователя надо и объяснять, и иллюстрировать, и описывать - без всякого сомнения. Но все это и козе понятно, и в ГОСТах 19-й системы прописано.

Итак, вряд ли разрабатывать руководства пользователя, основываясь исключительно на рекомендациях IEEE Std 1063-2001. Причины, как минимум, две:

отсутствие в IEEE Std 1063-2001 четко регламентированной структуры руководства пользователя;
«поверхностность» IEEE Std 1063-2001, отсутствие «широты охвата» и «глубины проработки».

Отсутствие четко регламентированной структуры руководства пользователя даст возможность ТРЕТИРОВАТЬ , см. хотя бы. Бедняга-разработчик будет вынужден, по указке заказчика, изо дня в день менять местами разделы руководства пользователя (гарантированный минимум, полученный опытным путем).

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

По мнению автора, рекомендации IEEE Std 1063-2001, разработанного при участии сотни забугорных спецов, весьма и весьма поверхностны. Не сможет разработчик, работая по IEEE Std 1063-2001, охватить максимум «характеристик», свойственных программе. В IEEE Std 1063-2001 многие из них попросту не прописаны. Отсутствуют «широта охвата» и «глубина проработки», свойственные отечественным документам.

В крайнем разделе настоящей статьи приведена таблица соответствия ГОСТ 19 и IEEE Std 1063-2001, которую автор статьи начал было составлять, затем бросил и проверять не стал. А выводы пусть каждый сделает сам для себя. И, возможно, в чем-то поправит автора.

Пользовательские документы по ГОСТ 19 (ЕСПД)

В отличие от суперсовременного буржуйского IEEE Std 1063-2001, древние, многими ругаемые отечественные стандарты 19-й системы (Единая система программной документации - ЕСПД) содержат не пространные рассуждения о том, что и как должно разъяснять, иллюстрировать и описывать руководство пользователя, а конкретные требования к структуре и содержанию пользовательских (эксплуатационных) документов.

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

Структура разделов описания программы по ГОСТ 19.402-78

Структура разделов описания применения по ГОСТ 19.502-78

Структура разделов руководства системного программиста по ГОСТ 19.503-79

Структура разделов руководства программиста по ГОСТ 19.504-79

Структура разделов руководства оператора по ГОСТ 19.505-79

Выводы по ГОСТам 19.ххх

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

Зато структуры «описательных» документов ГОСТ 19 обладают как полностью идентичными (по тексту названий), так и схожими по тексту названий разделами и подразделами. К идентичным разделам относятся, к примеру, разделы «», имеющие место во всех документах согласно. К схожим (фактически - идентичным) можно отнести подразделы «Назначение программы» и «».

А почему не попытаться объединить все «описательные» документы? Объединить идентичные и схожие разделы документов, выделить специфические разделы? Быть может, удастся избавиться от неполноты ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 и получить обобщенную структуру «описательного» документа и обозвать сам документ руководством пользователя программы?

ГОСТы 19.ххх допускают «вводить дополнительные разделы или объединять отдельные разделы», а также «вводить новые». Согласно ГОСТ 19.101-77 «Допускается объединять отдельные виды эксплуатационных документов (за исключением и). Необходимость указывается в. Объединенному документу присваивают и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ [из п. 2.6 ГОСТ 19.101-77]»

Сказано - сделано. Только мы нарушим ГОСТы и создадим объединенный документ под названием «Руководство пользователя».

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

Путем слияния структур «описательных» документов ГОСТов 19-й системы в единую структуру, удаления «лишних» одноименных разделов, слияния схожих разделов сформирована общая структура руководства пользователя программы. В табличке сведены и «* » отмечены разделы, присутствующие в каждом отдельном документе.

ГОСТ 19.ххх - обобщенная структура разделов руководства	ГОСТ 19.402-78	ГОСТ 19.502-78	ГОСТ 19.503-79	ГОСТ 19.504-79	ГОСТ 19.505-79
Аннотация
Назначение документа

Общие сведения о программе
Обозначение и программы
На которых написана программа
Сведения о назначении программы
Информация, достаточная для понимания и ее
Возможности программы
Классы решаемых задач
Описание задач
Методы решения задач


Временные характеристики
Режим работы



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

Сведения о и, обеспечивающих выполнение программы

Типы, используемые при работе программы


Требования к составу и параметрам




Описание логической структуры
Программы
Используемые методы
Сведения о
Сведения о программы



Сведения о и

Сведения о входных данных

Сведения о выходных данных

Формат, описание и способ выходных данных




Выбор функций
Поясняющие примеры

Описание способов проверки программы
Контрольные примеры
Методы прогона
Результаты
Выполнение программы

Запуск программы
Входные точки в программу*
Способы передачи управления и данных
Выполнение программы

Формат и возможные варианты для выполнения функции 1


Дополнительные возможности



Тексты, выдаваемых в ходе (настройки, проверки, выполнения) программы
Описание содержания

Выводы по обобщенной структуре руководства пользователя по ГОСТ 19.ххх

Обобщенная структура руководства пользователя по ГОСТ 19.ххх явно не страдает, как IEEE Std 1063-2001, отсутствием широты охвата. Избыток, как известно, рождает качество. Перечислено все, чем может характеризоваться программа. Отдельные подразделы могут показаться даже излишними, к примеру, подраздел «Языки программирования, на которых написана программа».

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

В то же время, при всей широте охвата, в явном виде отсутствуют:

Software installation and de-installation, if performed by the user;
Orientation to use of the features of the graphical user interface;
Access, or log-on and sign-off the software;
Navigation through the software to access and to exit from functions и многое другое.

Автору удалось разбросать кое-что в разделе Таблица соответствия ГОСТ 19.ххх и IEEE Std 1063-2001, но времени «наморщить ум» всегда не хватает, руководство пользователя, как всегда, должно было быть готово еще на прошлой неделе.

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

Выводы по источникам

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

Автор манифеста более склонен к рекомендациям по подбору слов * и построению предложений, IEEE Std 1063-2001, в лучшем случае, приводит требования к структуре руководства пользователя, но не дает особой конкретики, в ГОСТ 19.ххх не прописаны процедуры заполнения разделов руководства. Может, организовать эдакую смесь французского с нижегородским? Использовать все четыре источника в качестве четырех составных частей?

* Нынче в моде буржуйское - т.н. контролируемый язык . Среди представителей «просвещенной русской интеллигенции» наибольшей популярностью пользуется отечественный аналог в глагольной форме повелительного наклонения - фильтруй базар !

Смесь французского с нижегородским

Почему бы нет? Взять лучшее из ГОСТов 19-й системы, - обобщенную структуру руководства пользователя, добавить к ней немногочисленные толковые из IEEE Std 1063-2001 и разбавить неисчерпаемой стилистической культурой и ресурсами из манифеста Кагарлицкого? Придать смеси стройный строгий вид, сформировать очередной с подробными комментариями? А что делать, если ни один из перечисленных выше источников и составных частей в отдельности не способны дать ответы на все поставленные вопросы?

Таблица соответствия ГОСТ 19 и IEEE Std 1063-2001

ГОСТ 19.ххх	IEEE Std 1063-2001
Аннотация
	The introduction shall describe the intended audience, scope, and purpose for the document and include a brief overview of the software purpose, functions, and operating environment
Назначение документа	purpose for the document (Introduction)
Краткое изложение основной части документа	scope (Introduction)
Общие сведения о программе
Обозначение и наименование программы
Языки программирования, на которых написана программа
Сведения о назначении программы	brief overview of the software purpose (Introduction)
Информация, достаточная для понимания функций программы и ее эксплуатации	аналогичный подраздел отсутствует
Возможности программы
Классы решаемых задач
Описание задач
Методы решения задач	Documentation shall relate each documented function to the overall process or tasks
Функции, выполняемые программой	brief overview of the software ... functions (Introduction)
Описание основных характеристик и особенностей программы	аналогичный подраздел отсутствует
Временные характеристики
Режим работы
Средства контроля правильности выполнения и самовосстанавливаемости программы
Ограничения области применения программы
Сведения о функциональных ограничениях на применение
Условия применения программы	If different versions of the software are available for different operating environments, the title page should specify the applicable operating environment(s), including version(s) of hardware, communications, and operating system(s) (4.3. Content of identification data)
Условия, необходимые для выполнения программы	аналогичный подраздел отсутствует
Сведения о технических и программных средствах, обеспечивающих выполнение программы	Documentation for the hardware and software environment (4.11 Information on related information sources)
Требования к техническим средствам	аналогичный подраздел отсутствует
Устройств, используемые при работе программы
Объем оперативной памяти
Минимальный и (или) максимальный состав аппаратурных и программных средств
Требования к составу и параметрам периферийных устройств
Программное обеспечение, необходимое для функционирование программы	brief overview of the ... operating environment (Introduction)
Требования к программному обеспечению	аналогичный подраздел отсутствует
Требования к другим программам
Требования и условия организационного, технического и технологического характера
Описание логической структуры
Алгоритм программы	algorithms (4.5 Concept of operations)
Используемые методы	using such methods as a visual or verbal overview of the process or workflow (4.5 Concept of operations)
Сведения о структуре программы	аналогичный подраздел отсутствует
Сведения о составных частях программы
Описание функций составных частей
Сведения о связях между составными частями программы
Сведения о связях с другими программами
Сведения о входных и выходных данных
Общие характеристики входной и выходной информации	аналогичный подраздел отсутствует
Сведения о входных данных
Характер, организация и предварительная подготовка входных данных
Сведения о выходных данных
Характер и организация выходных данных
Формат, описание и способ кодирования выходных данных
Описание кодирования информации
Настройка программы	Identification of technical or administrative activities that must be done before starting the task (4.7 Information for procedures and tutorials)
Описание действий по настройке программы	аналогичный подраздел отсутствует
Настройка на состав технических средств
Выбор функций
Поясняющие примеры
Проверка программы
Описание способов проверки работоспособности программы	аналогичный подраздел отсутствует
Контрольные примеры	Examples should illustrate the use of commands (4.8 Information on software commands)
Методы прогона	аналогичный подраздел отсутствует
Результаты
Выполнение программы
	Software installation and de-installation, if performed by the user (4.6 Information for general use of the software)
Запуск программы	аналогичный подраздел отсутствует
Входные точки в программу*	Access, or log-on and sign-off the software (4.6 Information for general use of the software)
Способы передачи управления и параметров данных	аналогичный подраздел отсутствует
Выполнение программы
Описание выполняемой функции 1	A brief overview of the purpose of the procedure and definitions or explanations of necessary concepts not elsewhere included (4.7 Information for procedures and tutorials)
Формат и возможные варианты команд для выполнения функции 1	Navigation through the software to access ... functions (4.6 Information for general use of the software) Instructional steps shall be presented in the order of performance (4.7 Information for procedures and tutorials) Documentation shall explain how to interrupt and undo operation during execution of a command and how to restart it, if possible. Documentation shall explain the formats and procedures for user-entered software commands, including required parameters, optional parameters, default options, order of commands, and syntax (4.8 Information on software commands)
Ответы программы на команды выполнения функции 1	Documentation shall describe how to recognize that the command has successfully executed or abnormally terminated (4.8 Information on software commands)
Завершение выполнения программы	Navigation through the software ... to exit from functions Methods of canceling, interrupting, and restarting operations (4.6 Information for general use of the software)
Дополнительные возможности
Описание дополнительных функциональных возможностей программы	аналогичный подраздел отсутствует
Описание применения дополнительных функциональных возможностей программы
Сообщения программы	Relevant warnings, cautions, and notes that apply to the entire procedure (4.7 Information for procedures and tutorials)
Тексты сообщений, выдаваемых в ходе (настройки, проверки, выполнения) программы	аналогичный подраздел отсутствует
Описание содержания
Описание действий, которые необходимо предпринять по этим сообщениям

Программный компонент комплекса или системы

Цели и задачи

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

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

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

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

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

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

Методика и стиль изложения

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

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

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

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

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

Типовая структура

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

Общие сведения.
Установка и первоначальная настройка.
Основные понятия и определения.
Интерфейс пользователя.
Работа с программой.
Пользовательская настройка.
Сообщения об ошибках.

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

Особенности

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

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

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

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

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

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

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

излагайте ясно, используйте короткие предложения;

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

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

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

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

описание установки;

описание запуска;

инструкции по работе (или описание пользовательского интерфейса);

сообщения пользователю.

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

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

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

Раздел Инструкции по работе обычно содержит описание режимов работы, форматок вводавывода информации и возможных настроек.

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

11.4. Руководство системного программиста

По ГОСТ 19.503-79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. Кроме того, как указывалось выше, в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505-79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508-79). В настоящее время данную схему используют для составления руководства системному администратору.

Руководство системного программиста должно содержать следующие разделы:

Общие сведения о программном продукте,

структура,

настройка,

проверка,

дополнительные возможности,

сообщения системному программисту.

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

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

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

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

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

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

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

11.5. Основные правила оформления программной документации

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

Оформление текстового и графического материала. Текстовые документы оформляют на листах формата А4, причем графический матерная допускается представлять на листах формата A3. Поля на листе определяют в соответствии с общими требованиями: левое - не менее 30, правое - не менее 10, верхнее - не менее 15, а нижнее - не менее 20 мм. В текстовых редакторах для оформления записки параметры страницы заказывают в зависимости от устройства печати. При ручном оформлении документов параметры страницы выбирают из соображений удобства.

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

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

при выполнении документа машинописным способом - двум интервалам;

при выполнении рукописным способом - 10 мм;

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

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

при выполнении документа машинописным способом - трем интервалам;

при выполнении рукописным способом - не менее 15 мм;

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

Разделы и подразделы нумеруются арабскими цифрами с точкой. Разделы должны иметь порядковые номера 1,2, и т. д. Номер подраздела включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой. Например: 2.1, 3.5. Ссылки на пункты, разделы и подразделы указывают, используя порядковый номер раздела или пункта, на-

пример, «в разд. 4», «в п. 3.3.4».

Текст разделов печатают через 1,5-2 интервала. При использовании текстовых редакторов высота букв и цифр должна быть не менее 1,8 мм (шрифты №11-12).

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

Оформление рисунков, схем алгоритмов, таблиц и формул. В соответствии с ГОСТ 2.105-79 «Общие требования к текстовым документам» иллюстрации (графики, схемы, диаграммы) могут быть приведены как в основном тексте, так и в приложении. Все иллюстрации именуют рисунками. Все рисунки, таблицы и формулы нумеруют арабскими цифрами последовательно (сквозная нумерация) или в пределах раздела (относительная нумерация). В приложении - в пределах приложения.

Каждый рисунок должен иметь подрисуночную подпись - название, помещаемую под рисунком, например:

Рис.12. Форма окна основного меню

На все рисунки, таблицы и формулы в записке должны быть ссылки в виде: «(рис. 12)» или «форма окна основного меню приведена на рис. 12».

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

Если рисунок занимает более одной страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Например:

Рис. 12. Продолжение

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

Схемы алгоритмов должны быть выполнены в соответствии со стандартом ЕСПД. Толщина сплошной линии при вычерчивании схем алгоритмов должна составлять от 0,6... 1 ,5 мм. Надписи на схемах должны быть выполнены чертежным шрифтом, высота букв и цифр должна быть не менее 3,5 мм.

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

Результаты тестов приведены в табл. 4.

Номер формулы ставится с правой стороны страницы в крутых скобках на уровне формулы. Например:

z: =sin (x)+In (y);

Оформление приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» прописными буквами и иметь тематический заголовок. При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д. Например:

ПРИЛОЖЕНИЕ 2

Титульный лист расчетно-пояснительной записки

Рисунки и таблицы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения с добавлением буквы «П». Например:

Рис. П. 12 - 12-й рисунок приложения; Рис. Ш.2 - 2-й рисунок 1 -го приложения.

Если в приложении приводится текст программы, то каждый файл оформляют как рисунок с наименованием файла и его назначением, например:

Рис. П2.4. Файл menuran.pasпрограмма движения курсора основного меню.

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

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

11.6. Правила оформления расчетно-пояснительных записок при курсовом проектировании

При оформлении пояснительных записок следует придерживаться ГОСТ 7.32-91 (ИСО 596682) «Отчет по научно-исследовательской работе. Структура и правила оформления». В соответствии с этим стандартом текстовый документ подобного типа должен включать:

титульный лист,

реферат,

содержание,

введение,

основную часть,

заключение,

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

приложения.

Титульный лист оформляют в соответствии с ГОСТ 19.104-78 «Единая система программной документации. Основные надписи» (рис. 11.1).

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

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

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

В качестве примера рассмотрим оглавление пояснительной записки к проекту по курсу «Технология программирования».


Введение..................................................................................................................................................
1.Выбор технологии, языка и среды программирования.....................................................................
2.Анализ и уточнение требований к программному продукту..........................................................
2.1.Анализ процесса обработки информации и выбор структур
данных для ее хранения..............................................................................................................
2.2.Выбор методов и разработка основных алгоритмов решения задачи...................................
3.Разработка структурной схемы программного продукта.............................................................
4.Проектирование интерфейса пользователя....................................................................................
4.1.Построение графа диалога......................................................................................................
4.2.Разработка форм ввода-вывода информации........................................................................
5.Проектирование классов предметной области..............................................................................
5.1.Построение диаграммы классов.............................................................................................
5.2.Уточнение структуры классов предметной области
и разработка алгоритмов методов..........................................................................................
6.Выбор стратегии тестирования и разработка тестов.....................................................................
Заключение...........................................................................................................................................
Список литературы..............................................................................................................................
Приложение 1. Техническое задание.................................................................................................
Приложение 2. Руководство пользователя........................................................................................

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

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

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

3.На кого рассчитано руководство пользователя? Что оно должно содержать? В каких ситуациях вы читаете руководство пользователя? Вспомните прочитанные вами руководства пользователя. Что вам в них не понравилось?

ПРИЛОЖЕНИЕ

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

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

диаграммы вариантов использования или прецедентов(uses case diagrams) - показывают основные функции системы для каждого типа пользователей;

диаграммы классов (class diagrams): контекстные, описания интерфейсов и реализации - демонстрируют отношения классов между собой;

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

диаграммы взаимодействия (interaction diagrams) двух альтернативных типов:

а) диаграммы последовательности действий(sequence diagrams) - отображают упорядоченное по времени взаимодействие объектов в процессе выполнения варианта использования,

б) диаграммы кооперации (collaboration diagrams) – предоставляют ту же информацию, что и диаграммы последовательности действий, но в форме, позволяющей лучше представить ответственности классов в целом;

диаграммы состояний объекта (statechart diagrams) - показывают состояния объекта и условия переходов из одного состояния в другое;

диаграммы пакетов (package diagrams) - демонстрируют связи наборов классов, объединенных в пакеты, между собой;

диаграммы компонентов (component diagrams) - показывают, из каких программных компонентов состоит программное обеспечение и как эти компоненты связаны между собой;

диаграммы размещения (deployment diagrams) - позволяют связать программные и аппаратные компоненты системы.

Дополнениями к диаграммам служат формализованные и неформализованные текстовые описания, комментарии и словари.

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

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

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

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

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

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

Большинство пользователей не разбираются в функциях и навигации онлайн-сервиса; 40% пользователей не читают инструкции на сайте и обращаются за помощью к консультантам. Лишь 10% приступают к работе с сервисом без дополнительной помощи, поскольку имеют необходимый пользовательский опыт .

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

Известный специалист в области юзабилити Якоб Нильсен утверждает, что “система должна быть равным образом приемлема для двух групп пользователей - новичков и опытных” (принцип гибкости и эффективности, одно из “10 эвристических правил дизайна пользовательского интерфейса”).

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

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

О чем спрашивают начинающие пользователи

Новые пользователи задают два вопроса:

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

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

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

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

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

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

Мы адаптировали эти советы.

Хорошая справочная статья	Плохая справочная статья
Содержит четкие описания шагов, которые приведут пользователя к цели	Предлагает пользователю самостоятельно определить проблему и выбрать решение из списка
Предлагает инструкции для решения только текущей задачи Нажмите «ОК» и ваше письмо уйдет адресату	Содержит список советов, относящихся к данному этапу работы с системой: Чтобы написать письмо - нажмите «Создать» Чтобы удалить письмо - нажмите «В Корзину» Чтобы отправить письмо - нажмите «ОК»
Размещена на видном месте, появляется, если пользователь зашел на сайт и 10 секунд не выполняет никаких действий	Спрятана в разделе «Помощь по сайту», который никто не читает
Умещается в нескольких предложениях	Содержит много страниц и ссылок

Правила американского юзабилиста дополняет российский специалист, автор книги “Shareware: профессиональная разработка и продвижение программ” Станислав Жарков:

“При описании пути решения проблемы, как и при написании любой документации, нужно избегать составления слишком объемных текстов, т. к. пользователи будут просто пробегать их глазами, не вникая в смысл написанного, подобно тому, как человек, просматривающий газету, сначала останавливает взгляд на коротких заметках, пропуская большие материалы. Лучше всего составить что-то наподобие пошаговой инструкции, каждый шаг из которой составляет 1—2 предложения” (“Shareware: профессиональная разработка и продвижение программ”, СПб., 2001).

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

Создаем инструкции с помощью подсказок

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

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

А это пример подсказки для пользователей Google Plus .

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

Чек-лист для разработки эффективной инструкции в форме подсказок

1. Опишите подсказками конкретные шаги пользователей.

2. Создайте обучающие туры для сценариев работы.

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

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

5. Показывайте подсказки автоматически только один раз, при первом посещении пользователя.

6. Разрешите пользователю включать демо-туры в любой момент.

7. Оформите подсказки в едином для сервиса дизайне.

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

Для создания одностраничных инструкций (для одного окна интерфейса) подходят готовые библиотеки кода Java Script: Intro.js и Bootstro.js . Для создания кросс-страничных подсказок подойдут сервисы Hintarea и Walkme.com .

Подсказки могут помочь тем, кто:

установил новое мобильное приложение;
воспользовался онлайн-сервисом (системой бронирования, доской объявлений);
оформляет заказ в интернет-магазине;
работает с бизнес-приложением (CMS, CRM).

Пример: подсказки для обучения пользователей CMS Wordpress

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

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

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

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

Объясним пользователю, с чего начинать

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

Научим правильно заполнять формы

Обратим внимание на важные функции

Формируем понимание работы с контентом

Объясним специальные термины

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

Еще раз о пользе

Ценность подсказок для пользователей очевидна - те, кому раньше требовалась помощь, осваивают сервис или приложение самостоятельно.

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

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

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

Это перевод статьи, ранее опубликованной в американском журнале для интернет-предпринимателей sandhill.com.

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