Программное обеспечение, устройства – для всего этого необходимо руководство пользователя – инструкция, где указано, как пользоваться продуктом (и чего делать не надо). Руководство пользователя – это официальная информация с определенной структурой, оно должно быть написано тем, кто близко знаком с продуктом, как, например, технический специалист или создатель продукта. Важными особенностями языка инструкций являются одноязычность, точность и простота написания для беспроблемного пользования продуктом.
Планирование
1
Анализ аудитории. Руководство пользователя должно быть написано так, чтобы быть понятным вашей аудитории. Определитесь с вашей целевой аудиторией и учитывайте ее при написании руководства.
- Поговорите с людьми, которые будут пользоваться вашим устройством. Покажите им прототипы устройства и проект руководства пользователя в контролируемых условиях. Попросите их рассказать о моментах, которые неочевидны или сбивают с толку в тексте руководства, после чего отредактируйте их согласно этой обратной связи.
- Пишите руководство для целевой или наиболее многочисленной аудитории.
- Подумайте о возрасте опрашиваемых, состоянии их здоровья (есть ли у них болезни, нарушения, влияющие на обучение, или инвалидность), об уровне их образования, чтобы определить наилучший подход к написанию руководства пользователя.
2
Дизайн
Часто создатели продукта не могут доступно объяснить принцип его работы. Поэтому лучше обратиться за помощью к техническому писателю (желательно с опытом написания инструкций). Также вам понадобится графический дизайнер, который будет отвечать за визуальную составляющую вашего руководства.
3
Анализ задач. Анализ задач — это процесс выявления и организации шагов, необходимых для эксплуатации вашего продукта.
- Если ваш продукт может выполнять много разных задач или подзадач, вам надо проанализировать каждую задачу. Например, в автомобиле вы можете сигналить гудком, пристегиваться и включать или выключать фары. Проведите анализ задач для каждой из этих команд.
4
Убедитесь, что ваш продукт соответствует требованиям маркировки и маркетинга. Эти требования гарантируют, что продукты производятся с учетом требований к обеспечению безопасности пользователя, и ограничивают воздействие опасных условий, таких как радиация и поражение электрическим током, на потребителя. Рекламные объявления должны четко демонстрировать, какова цель и основные инструкции по эксплуатации продукта, и вы должны использовать эти источники при написании руководства пользователя.
- Руководство пользователя должно соответствовать этикеткам, прикрепленным непосредственно к продукту.
- Убедитесь, что ваше устройство имеет лицензию на продажу, прежде чем писать инструкцию по эксплуатации.
5
Определитесь с макетом вашего руководства. Есть несколько способов рационализировать вашу работу. Стоит поместить в начале каждого раздела жирный заголовок, где каждое слово будет начинаться с большой буквы. Например, «Настройка устройства», «Работа с устройством» и «Устранение неполадок» могут быть выделены жирным шрифтом.
- Еще один способ упростить руководство — использовать два столбца, один справа с текста, а другой слева от текста с маркерами, цифрами или маленькими значками, такими как предупреждающие знаки или красные восклицательные знаки.
- Ваше руководство может состоять в основном из изображений с подписями под каждой картинкой для объяснения устройства, или наоборот, это может быть в основном текст с несколькими сопровождающими изображениями. Вы также можете использовать блок-схему, чтобы показать пользователю указания по действиям. Когда будете писать руководство, подумайте о вашем продукте и о том, насколько полезным будет каждый из предложенных методов. Однако старайтесь не использовать разные макеты в одном руководстве. Выберите один и придерживайтесь его.
Добавление основной информации
1
Организуйте руководство логически. Руководство пользователя должно быть составлено таким образом, чтобы пользователь счел его наиболее полезным. Разделите руководство на главы или разделы, которые описывают какую-то деталь в использовании продукта, и вставьте оглавление в начале руководства, чтобы каждый раздел можно было быстро найти.
- Для длинных руководств оглавление особенно важно.
- Словарь или указатель необходимы, если есть много терминов, объясняющих то, с чем ваша аудитория может быть не знакома. Однако не рекомендуется включать словари; лучше всего описывать незнакомые термины прямо в тексте руководства. Если вы все-таки решите оставить словарь, вставьте его в начале, сразу за оглавлением.
- Список таблиц или рисунков необходим только в том случае, если в руководстве имеется более 2-3 таблиц или рисунков.
- Приложение необходимо для понятий, которые должны быть объяснены, но этого нельзя сделать в другом месте в руководстве, потому что это нарушит поток и фокус.
2
Включите необходимые предупреждения. Общие предупреждения или предостерегающая информация должны содержать информацию о потенциальных угрозах, которые могут возникнуть в результате неправильного использования продукта, включая смерть или серьезные травмы. Эти предупреждения должны быть размещены в самом начале руководства после титульной страницы, чтобы пользователь мог их увидеть первыми. Конкретные предупреждения также должны быть включены в текст руководства пользователя сразу после или перед тем, как будет предложен потенциально опасный шаг.
- Например, общее предупреждение для электрического устройства может состоять в том, чтобы избегать его использования во время дождя.
- Конкретное предупреждение может состоять в том, чтобы убедиться, что и устройство, и ваши руки сухие, перед тем, как подключать устройство к току.
- Добавьте графику (например, череп и скрещенные кости) или разноцветный текст (например, красный текст), чтобы отличить предупреждение от остальных указаний в руководстве пользователя и привлечь к нему внимание пользователей.
3
Опишите устройство. Ваше описание должно включать как письменное объяснение цели устройства, так и небольшой рисунок, изображающий, как устройство выглядит. На рисунке должны быть правильно обозначены и названы все переключатели, ручки и присоединяемые части, которые есть на устройстве.
4
Пропишите инструкции по настройке. Раздел настройки должен содержать основную информацию о том, как подготовиться к использованию продукта или устройства. Если устройство не может быть собрано или настроено домашним пользователем, изложите этот факт в полужирном заголовке в верхней части раздела настройки. Вы также должны добавить:
- Список частей
- Инструкции по распаковке
- Предупреждения по настройке
- Последствия неправильной настройки
- Куда обращаться, если пользователь сталкивается с трудностями при настройке
5
Предоставьте информацию об использовании. Этот раздел является основной частью руководства пользователя и должен содержать конкретную, подробную информацию о том, как пользоваться устройством. Начните с основной подготовке к использованию устройства, такой как подключение или мытье рук. Переходите к логическим пронумерованным шагам, описывающим, каким образом стоит пользоваться устройством, а также к деталям, которые пользователь сможет заметить при правильном пользовании устройством (например, «Вы услышите щелчок…»).
- В конце этого раздела надо перенаправить пользователей к разделу устранения неполадок для решения проблем, которые нельзя объяснить вкратце.
- Добавьте изображения, где это необходимо. Некоторые шаги лучше всего объяснить изображениями и словами. Подумайте об использовании фотографий или иллюстраций в вашем руководстве пользователя.
- В этом разделе, как и в остальных, не забудьте вставить необходимые предупреждения о неправильном использовании и работе устройства. Например, вы можете предупредить пользователей бензопилы, чтобы они не употребляли алкоголь или не использовали бензопилу во время приема некоторых лекарств.
- Рассмотрите возможность включения ссылок на онлайн-видео, демонстрирующие правильное использование и работу устройства, если вы считаете, что это будет полезным пользователям. Вы можете добавить эти видео либо в начале этого раздела, либо (если видео иллюстрирует только один шаг) в конце каждого шага.
6
Включите краткую сводку по продукту в конце. Сводка должна идти в конце руководства, непосредственно перед указателем, чтобы описать основные этапы работы. Это должна быть упрощенная, короткая версия раздела с оперативной информацией и она должна занимать не более одной страницы. Подведите итог, как использовать устройство или продукт. Включите сюда предупреждения, пронумерованные шаги, объясняющие использование продукта, телефонные номера и адреса электронной почты для помощи.
- Если предполагается, что пользователь вырвет сводный лист, или ему нужно будет регулярно с ним обращаться, вы можете напечатать его на ламинированной карточке, которую можно будет извлечь, или толстой карточке, чтобы пользователю было легче носить ее с собой и ссылаться на нее.
- Либо приложите сводку прямо к продукту, чтобы пользователи могли быстро и легко использовать ее.
Описание ухода за продуктом
1
Объясните, как чистить устройство. Если ваше устройство или продукт необходимо чистить, объясните, как это сделать. Обязательно перечислите необходимые чистящие средства. Расскажите читателю, как часто надо чистить. Затем, как и в любом другом разделе руководства пользователя, опишите пронумерованные пошаговые инструкции о том, как следует проводить очистку.
- Если очистка требует какой-либо разборки продукта или удаления определенной детали или частей, обязательно включите информацию о том, как его разобрать.
- Включить предупреждение, о последствиях, которые будут, если не чистить устройство. Например, вы можете сказать: «Отсутствие чистки приведет к снижению оптимальной производительности».
2
Расскажите пользователю, как выполнять базовое обслуживание. Если продукт или устройство может обслуживаться пользователем для устранения проблем с производительностью, добавьте пронумерованные указания относительно того, как пользователь может это сделать. Например, если необходимо менять батареи через каждые 300 часов использования, опишите, как проверить, что батареи надо менять, как извлекать старые батареи и как вставлять новые.
- Если некоторые задачи по техническому обслуживанию могут быть выполнены только сертифицированным специалистом, разделите этот раздел по обслуживанию на две части.
3
Обсудите варианты хранения. В руководстве пользователя при необходимости должно быть объяснено, как правильно хранить изделие или устройство. Также вы должны добавить информацию о том, почему правильное хранение необходимо и каковы могут быть последствия неправильного хранения. Например, вы можете написать:
- «Храните продукт в прохладном сухом месте. Неправильное хранение может сократить срок использования вашего продукта из-за накопления в нем влаги.»
- «Не подвергайте изделие нагреванию и не храните при температуре выше 120 °F (49 °C). Это может привести к возгоранию.»
4
Добавьте информацию по устранению неполадок. Вы можете оформить этот раздел как список основных проблем и путей и решения. Сгруппируйте похожие неполадки в одну категорию под логичным заголовком. Таким образом пользователи смогут найти конкретную проблему быстро.
- Например, если есть несколько проблем с отображением синего экрана на компьютере, поместите их вместе с подзаголовком «Общие проблемы с экраном».
- Вы также должны указать номер телефона и/или адрес электронной почты отдела обслуживания клиентов в этом разделе.
Написание читаемого руководства
1
Почитайте другие руководства пользователя. Перед написанием руководства пользователя вашего собственного продукта, взгляните на другие качественные руководства. Обратите внимание на структуру, подбор слов и стиль. Крупные бренды, такие как Apple, Google и Microsoft делают сильные и полезные руководства пользователя, которые могут помочь вам написать более продуманное руководство.
- Не просто читайте любые руководства пользователя. Выбирайте руководства к продуктам, похожим на те, что вы продаете. Например, если вы занимаетесь товарами для младенцев, читайте руководства к ним, а не технические инструкции.
2
Выберите свой формат. Стандартизация правописания, выбора слов и фраз сделает руководство удобнее для пользователя. Руководство по стилю университета Чикагской прессы и стилистический справочник Microsoft также могут быть полезными руководствами по стилю при написании руководства пользователя; просмотрите оба, чтобы понять, подойдет ли какой-нибудь для вашей работы.
- Например, вместо того, чтобы использовать и «включатель / выключатель», и «выключатель питания» в вашем руководстве пользователя, выберите один или другой термин и придерживайтесь его.
3
Напишите пронумерованные указания. Пронумерованные инструкции помогут читателю сосредоточиться на процессе использования, подключения или сборки данного продукта. Вместо того, чтобы писать длинный беспорядочный абзац или серию ненумерованных абзацев, напишите свое руководство пользователя с простыми, ясными шагами, каждый из которых четко пронумерован.
4
Начинайте прописывать каждый шаг с глагола в повелительном наклонении. Начиная каждый шаг с глагола, вы наводите читателя на действие, необходимое для завершения шага. Например, в зависимости от продукта, о котором вы пишите, вы можете начать описание ваших шагов с таких глаголов в повелительном наклонении, как подсоедините, прикрепите или просуньте. Однако, не начинайте со слов, описывающих действия самой системы.
- Например, если экран станет голубым и будет мерцать, не начинайте написание инструкции с фразы: «Экран начнет мерцать и станет голубым». Попробуйте: «Нажмите и удерживайте клавишу возврата. «Экран начнет мерцать и станет голубым».
6
Определитесь, каким регистром слов вы будете пользоваться. Если вы пишете руководство пользователя для игрушки йо-йо, ваша аудитория будет в основном состоять из маленьких детей. Пользуйтесь простыми словами, чтобы объяснит, как работает йо-йо. Если же вы пишете руководство пользователя для сканирующего электронного микроскопа, вашей аудиторией будут высококвалифицированные ученые, способные воспринимать очень подробную информацию, поэтому не стесняйтесь пользоваться специализированным языком или описывать мелкие нюансы.
- В целом, старайтесь избежать жаргона и технических терминов.
- Чтобы быть эффективным для широкого круга пользователей, старайтесь писать на уровне чтения шестого-седьмого класса.
7
Если вы доставляете продукцию заграницу, убедитесь, что ваши переводы точны. Наймите специалиста, который переведет ваше руководство на язык страны, в которую вы отправляете вашу продукцию. Либо воспользуйтесь онлайн-переводчиком, но попросите носителя языка просмотреть перевод на наличие ошибок и исправить его.
- Если среди вашей аудитории представлено несколько языковых групп, добавьте переводы руководства пользователя на каждый соответствующий язык.
- Переводчик должен быть знаком с продуктом, так как в целевом языке могут быть разные слова для специфических терминов, которые не будут дословным переводом.
8
При написании будьте краткими. Вместо нескольких длинных абзацев, напишите много коротких. Ищите логические разрывы в каждом разделе и умещайте полезную информацию в одном или двух предложениях. То же надо применять и к предложениям. Ваши предложения должны быть короткими и простыми, а не длинными и бессвязными.
- Если один из шагов уже слишком длинный, разбейте его на несколько коротких. Количество слов от этого не уменьшится, но подобное разделение упростит чтение.
9
Проверьте руководство на предмет ошибок. Оно может потерять авторитет из-за грамматических и орфографических ошибок. Попросите коллегу или технического копирайтера проверить и отредактировать руководство. В добавок к орфографии и грамматике, редактор должен исправить:
- Страдательный залог
- Двусмысленный или запутанный язык
- Сложные структуры предложения
- Слишком длинные абзацы