Ex Machina: Дизайн для думающих

Последнее обновление 12.11.02

	Наблюдения   Интерфейс   Веб   Про инструмент   Про бумагу   Про контент

Как сделать хорошее руководство пользователя

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

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

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

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

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

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

Итак, с теорией всё стало ясно, пора переходить к практике. Далее идёт список советов в жанре контрольного списка.

Теория

Пользователи читают документацию в надежде получить от этого процесса знания. Существуют три типа знаний — Как (Что), Зачем и Почему:

• Как (Что). "Как мне включить магнитофон в электросеть?". "Что делает эта кнопка?".
• Почему. "Почему магнитофон сгорел, когда я облил его водой во время записи?"
• Зачем. "Зачем эту кнопку хорошо нажимать при записи?"

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

Содержание

Пишите компактно.

Избегайте прилагательных.

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

Старайтесь делать абзацы покороче.

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

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

Старайтесь поддерживаться фиксированной структуры глав.

У каждой главы должно быть введение, кратко описывающее её содержание.

Форма

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

Избегайте иллюстраций, они сбивают внимание при перелистывании.

Всё, что трудно передать словами, передавайте с помощью иллюстраций.

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

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

Две разные темы не должны описываться на одной странице.

Заголовки не должны теряться на фоне текста, лучшее место для них — поля.

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

Ни то, ни сё

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

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

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

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

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

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

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

См. также: Разработка пользовательской документации (семинар)

Я с благодарностью приму любые дополнения или критику.

Версия 1.2. Последнее обновление этого документа: 20.03.00