Содержание

• Шагать
• Часть 1 из 4: Планирование руководства пользователя
• Часть 2 из 4. Включение важной информации
• Часть 3 из 4: Описание обслуживания продукта
• Часть 4 из 4: напишите удобочитаемое руководство
• Советы

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

Шагать

Часть 1 из 4: Планирование руководства пользователя

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

Часть 2 из 4. Включение важной информации

1. Организуйте руководство логически. Руководство должно быть построено таким образом, чтобы пользователь мог извлечь из него максимальную пользу. Разделите руководство на главы или разделы, которые имеют смысл для использования продукта, и включите оглавление в начале руководства, чтобы каждый раздел можно было быстро найти.
   • Оглавление особенно необходимо для более длинных руководств.
   • Глоссарий или указатель необходимы, если для объяснения есть много терминов, с которыми ваша аудитория может быть не знакома. Однако глоссарий не рекомендуется; Лучше всего объяснять непонятные термины в самом тексте руководства. Если вы решите включить глоссарий, поместите его в начале руководства сразу после оглавления.
   • Список таблиц или рисунков необходим только в том случае, если в руководстве больше, чем несколько таблиц или рисунков.
   • Приложение необходимо для вещей, которые необходимо объяснить, но которые нельзя объяснить в другом месте в руководстве, так как это нарушит поток и фокус.
2. Включите необходимые предупреждения. Общие предупреждения или меры предосторожности должны содержать информацию о потенциальных опасностях, вызванных неправильным использованием продукта, включая смерть или серьезные травмы. Эти предупреждения следует размещать в самом начале руководства после первой страницы, чтобы пользователь увидел их первым. Конкретные предупреждения также должны быть включены в текст руководства сразу после или непосредственно перед предложением потенциально опасного шага.
   • Например, общее предупреждение для электрического прибора может заключаться в том, чтобы не использовать его во время дождя.
   • Специальная инструкция может заключаться в том, чтобы убедиться, что ваши руки и устройство сухие, прежде чем включать устройство в розетку.
   • Предоставьте изображения (например, череп и скрещенные кости) или текст другого цвета (например, красный текст), чтобы отличить предупреждение от остальных указаний в IFU и привлечь к нему внимание пользователей.
3. Опишите устройство. Ваше описание должно включать как письменное объяснение назначения устройства, так и небольшое графическое представление того, как устройство выглядит. На рисунке должны быть обозначены и названы все переключатели, кнопки и присоединяемые детали, содержащиеся в устройстве.
4. Предоставьте инструкции по установке. Раздел установки должен содержать основную информацию о том, как подготовиться к использованию продукта или устройства. Если устройство не может быть построено или настроено домашним пользователем, четко укажите это жирным заголовком в верхней части раздела, посвященного установке. Вы также должны включить следующее:
   • Список запчастей
   • Инструкции по распаковке
   • Предупреждения при установке
   • Последствия неправильной установки
   • Кому звонить в случае затруднений при установке
5. Предоставьте информацию об операции. Этот раздел является наиболее важной частью руководства пользователя и должен содержать конкретную подробную информацию о том, как использовать устройство. Начните с базовой подготовки к использованию устройства, такой как включение кабеля питания в розетку или мытье рук. Продолжайте с логических пронумерованных шагов, описывающих, как использовать устройство, а также любых отзывов (например, «Вы услышите щелчок ...»), которые пользователь может ожидать при правильном использовании устройства.
   • В конце этой главы пользователи должны быть отосланы к главе об устранении неполадок, чтобы решить проблемы, которые невозможно быстро объяснить.
   • Разместите изображения там, где это необходимо. Некоторые шаги лучше всего объяснить с помощью картинок и слов. Рассмотрите возможность использования фотографий или иллюстраций в вашем руководстве.
   • В этот раздел, как и в любой другой, вы должны включить соответствующие предупреждения о неправильном использовании или неправильной эксплуатации. Например, вы можете предупредить пользователей бензопилы не употреблять алкоголь и не пользоваться бензопилой во время приема определенных лекарств.
   • Если вы считаете, что пользователи получат выгоду, рассмотрите возможность включения ссылок на онлайн-видео, демонстрирующие правильное использование и работу устройства. Вы можете записывать эти видеоролики либо в начале этого раздела, либо (в случае видеороликов, которые иллюстрируют только один шаг) в конце каждого шага.
6. Включите краткое изложение продукта в конце. Краткое изложение должно появиться в конце руководства, непосредственно перед указателем, чтобы обеспечить основные рабочие шаги. Это должна быть упрощенная, урезанная версия оперативной информации, не более одной страницы. Кратко опишите, как следует использовать устройство или продукт. Включите основные предупреждения, пронумерованные шаги, объясняющие, как использовать продукт, а также номера телефонов или адреса электронной почты, которые направляют пользователей на помощь.
   • Если вы ожидаете, что пользователь будет часто снимать сводный лист или обращаться к нему, вы можете распечатать его на съемной ламинированной карточке или толстом картоне, чтобы пользователю было легче носить с собой и обращаться к нему.
   • Кроме того, вы можете применить резюме непосредственно к продукту для быстрого и удобного использования пользователем.

Часть 3 из 4: Описание обслуживания продукта

1. Объясните, как чистить прибор. Если ваше устройство или продукт нуждается в чистке, объясните, как это сделать. Перечислите необходимые чистящие средства. Скажите читателю, как часто нужно чистить. Затем, как и в любой другой части руководства, включите пронумерованные пошаговые инструкции по очистке.
   • Если для очистки требуется разобрать изделие или удалить определенную часть или детали, укажите, как следует разобрать изделие.
   • Предоставьте предупреждение о результатах невыполнения чистки устройства. Например, вы можете сказать: «Если устройство не очищать, производительность будет ниже оптимальной».
2. Подсчитайте пользователю, как выполнять базовое обслуживание. Если продукт или устройство подлежат обслуживанию пользователем для устранения проблем с производительностью, предоставьте нумерованные инструкции о том, как это сделать для пользователя. Например, если батареи необходимо заменять после каждых 300 часов использования, предоставьте инструкции о том, как проверить, нужно ли заменять батареи, как удалить разряженные батареи и как установить новые.
   • Если есть определенные задачи по обслуживанию, которые может выполнить только сертифицированный специалист, разделите часть руководства, посвященную техобслуживанию, на две части.
3. Обсудите варианты хранения. При необходимости в руководстве следует объяснить, как правильно хранить продукт или устройство. вы также должны включить информацию о том, почему необходимо хранение и о последствиях неправильного хранения. Например: вы можете написать:
   • Храните продукт в сухом прохладном месте. Неправильное хранение может сократить срок службы вашего продукта из-за накопления влаги ".
   • «Не подвергайте продукт воздействию тепла и не храните его при температуре выше 50 градусов Цельсия.Если вы это сделаете, это может привести к возгоранию ".
4. Предоставьте информацию об устранении неполадок. Вы можете организовать этот раздел в виде списка общих проблем и способов их решения. Сгруппируйте похожие проблемы под логическим заголовком. Таким образом пользователи могут быстро находить конкретные проблемы.
   • Например, если есть несколько проблем с отображением синего экрана на компьютере, сгруппируйте их под заголовком, например «Общие проблемы с экраном».
   • Вы также должны указать номер телефона и / или адрес электронной почты службы поддержки в этом разделе.

Часть 4 из 4: напишите удобочитаемое руководство

1. Прочтите другие руководства пользователя. Прежде чем писать руководство для вашего собственного продукта, ознакомьтесь с другими эффективными руководствами пользователя. Обратите внимание на структуру, выбор слов и структуру предложения. Крупные бренды, такие как Apple, Google и Microsoft, выпускают надежные и эффективные руководства пользователя, которые могут помочь вам составить более продуманное руководство пользователя.
   • Не читай просто все руководства пользователя. Прочтите руководства для аналогичных продуктов, которые вы продаете. Например, если вы продаете товары для детей, читайте руководства для детей, а не технические.
2. Выберите свои стандарты. Стандартизация орфографии, выбора слов и формулировок сделает руководство пользователя более удобным. Чикагское руководство по стилю и Руководство по стилю Microsoft также могут быть полезными руководствами по стилю при написании руководства для пользователя; проверьте оба, чтобы убедиться, что один из них подходит для вашего руководства.
   • Например, вместо того, чтобы использовать в руководстве как «выключатель питания», так и «кнопку питания», выберите один из двух терминов и придерживайтесь его.
3. Используйте активный голос. Активный голос - это способ письма, который объясняет вещи с точки зрения пользователя. Его легче понять, чем альтернативу, пассивный залог, в котором предмет не определен.
   • Попробуйте приложение Hemingway (www.hemmingwayapp.com), чтобы определить пассивные отрывки в вашем письме.
   • Изучите эти два примерных предложения - первое активное, а второе пассивное:
     • Открывать упаковку нужно медленно и осторожно.
     • Пакет следует открывать медленно и осторожно.
4. Напишите пронумерованные инструкции. Инструкции, упорядоченные по номерам, помогают читателю лучше сосредоточиться на процессе использования, подключения или сборки рассматриваемого продукта. Вместо того, чтобы писать длинный многословный абзац или серию ненумерованных абзацев, напишите свое руководство пользователя с простыми, четкими шагами, каждый из которых четко пронумерован.
5. Начинайте каждый шаг с повеления. Повелительное наклонение - это глагол, ориентированный на действие. Начиная каждый шаг с глагола, вы даете читателю подсказку о действии, которое требуется для его завершения. Например, в зависимости от продукта, о котором вы пишете, вы можете начать свои действия с такой команды, как «Подключиться», «Подтвердить» или «Сдвинуть». Однако не начинайте свои действия с ответа системы.
   • Например, если экран становится синим и начинает мигать, не начинайте шаг с: «Экран будет мигать и станет синим». Попробуйте: «Нажмите и удерживайте клавишу возврата на главный экран. Экран начнет мигать и станет синим ".
6. Определите, какой словарный запас вы будете использовать. Если вы пишете руководство по йо-йо, вашей аудиторией будут в основном маленькие дети. Используйте простые слова и словарный запас, чтобы объяснить, как работает йо-йо. Когда вы пишете руководство к сканирующему электронному микроскопу, ваша аудитория состоит из высококвалифицированных ученых, которые могут понять очень подробную информацию, поэтому не уклоняйтесь от использования специализированной лексики или подробных объяснений.
   • В общем, вы стараетесь избегать жаргона и технических терминов.
   • Чтобы быть эффективным для максимально широкого круга пользователей, попробуйте писать на уровне от шестого до седьмого класса начальной школы.
7. Отправляя товар за границу, убедитесь, что ваш перевод точен. Наймите переводчика, который переведет ваше руководство пользователя на родной язык страны, в которую вы отправляете свой продукт. Вы также можете использовать программу онлайн-перевода, но попросите носителя языка прочитать перевод и проверить наличие ошибок.
   • Если в вашей аудитории представлены несколько языковых групп, включите переводы руководства пользователя на каждый соответствующий язык.
   • Переводчик должен быть знаком с продуктом, поскольку на целевом языке могут быть разные слова для определенных терминов, которые не являются дословным переводом.
8. Пишите короткими предложениями. Вместо нескольких длинных абзацев вы используете много коротких абзацев. Ищите логические разрывы в каждом разделе и переваривайте полезную информацию кусками из одного или двух предложений. То же самое и на уровне предложений. Ваши предложения должны быть короткими и простыми, а не длинными и многословными.
   • Если шаг становится слишком длинным, разбейте его на более мелкие шаги. Это не уменьшит количество слов, но разрывы строк облегчат чтение.
9. Проверьте руководство на наличие ошибок. Руководство может потерять доверие из-за грамматических и орфографических ошибок. Попросите коллегу или технического писателя отредактировать и вычитать руководство. Помимо орфографии и грамматики, корректору следует обратить внимание на следующее:
   • Пассивный залог
   • Неясный или запутанный язык
   • Структура предложения с переносом
   • Слишком длинные абзацы

Советы

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