Убедитесь, что вы точно знаете, что читатели руководства должны научиться делать.
Существует большая разница между написанием инструкции по эксплуатации, в которой объясняется, как использовать предмет, и того, как его ремонтировать. Если вы пишете руководство для косметологов, которые будут использовать новую модель фена в салоне, это сильно отличается от создания руководства с целью объяснить, как обслуживать или ремонтировать фен.
Начните свой первый черновик с составления списка всех шагов, которые нужно выполнить, чтобы выполнить любую задачу, которую, как предполагается, объясняет руководство. После того, как вы составили список, используйте созданный вами список шагов, чтобы попробовать выполнить задачи самостоятельно. Это поможет вам определить, достаточно ли списка в существующем виде или необходимо внести изменения. Скорее всего, вы поймете, что нужно добавить еще несколько шагов или что некоторые из перечисленных пунктов нужно разбить на несколько шагов. При необходимости внесите изменения и продолжайте работать с инструкциями, пока они не станут легкими для выполнения.
Возьмите свой последний черновик и используйте свои навыки технического письма, чтобы перевести их в практическую часть руководства. Начните с полного списка материалов, чтобы читателям было легко собрать то, что им нужно. Для этого подходят маркированные списки. Фактические шаги должны быть представлены в виде пронумерованного списка, которому читатели могут следовать шаг за шагом.
После того, как шаги будут изложены, подумайте, где графические элементы могут помочь читателям следовать им и применять их. Разработайте соответствующие диаграммы, графики или иллюстрации для включения в текст вместе с шагами. Разместите их на странице, чтобы читатели могли четко видеть, какая часть письменных инструкций соответствует каждому изображению. Если вы не можете разработать графику самостоятельно, обратитесь к иллюстратору или художнику-графику.
После того, как основная часть инструкции (собственно инструкции) будет написана, сосредоточьтесь на разработке других разделов темы. Как минимум, вам понадобится вводный раздел и заключение.
Введение в руководство пользователя обычно начинается с благодарности пользователям за выбор продукта и общего обзора продукта.
Заключение обычно заканчивается подробностями о том, как связаться с компанией, а также информацией о гарантии и любых заявлениях об отказе от ответственности, которые могут потребоваться.
Также может быть полезно включить раздел часто задаваемых вопросов и / или руководство по устранению неполадок.
Руководства пользователя должны быть краткими и подробными. Какие бы разделы ни были включены, они должны быть написаны в техническом стиле письма, ориентированном на передачу максимального объема информации как можно меньшим количеством слов. Никогда не рекомендуется быть многословным только для того, чтобы добавить содержание и сделать руководство длиннее. Если на процедуру можно ответить всего несколькими предложениями, лучше оставить все как есть. Будьте краткими, переходя к сути и отвечая на все важные вопросы, которые необходимо решить. Излагайте детали, но учитывайте каждое слово. Слишком много слов может вызвать информационную перегрузку.
Убедитесь, что вся информация в руководстве пользователя верна. В руководствах пользователя нет права на ошибку. Хотя точность важна при написании любого текста, она действительно важна при написании руководства пользователя. В инструкциях обязательно должно быть четко указано, как использовать конкретное оборудование или следовать определенной процедуре. Проверьте все на точность, включая всю терминологию, порядок шагов и ясность языка.
Вычитайте внимательно, чтобы убедиться, что ваш документ не содержит всех видов ошибок, включая орфографические, пунктуационные и грамматические. Типографские и другие ошибки могут запутать читателя. Они также плохо отражают бренд, компанию или продукт.
Охват всей ключевой информации, необходимой читателям, имеет решающее значение для руководства пользователя, но документ также должен быть удобным для пользователя и легким для понимания. Это означает форматирование документа с учетом удобства чтения.
Выберите подходящий шрифт, не используйте шрифтом меньше 10, в зависимости от вашей аудитории вам может потребоваться более крупный шрифт.
Предоставьте к продукту настоящее руководство пользователя, не заставляйте людей читать pdf.
Убедитесь, что инструкции действительно соответствуют продукту во всех отношениях.
Представьте инструкции в виде пошаговых инструкций.
Расскажите пользователю, какие есть функции и для чего они нужны, а не только как их использовать.
В инструкции избегайте рекламы.
Пишите руководство пользователя синхронно с графиком разработки продукта, а не под давлением сроков доставки.
Примите во внимание потребности пользователей с ограниченными возможностями (например, слабовидящих, дальтоников), если это продукт для бытового применения и предоставьте альтернативные руководства, написанные шрифтом Брайля, крупным шрифтом, аудио и т. д.
Протестируйте продукт и руководство пользователя на реальных пользователях (включая пользователей с ограниченными возможностями).
Многие пользователи никогда не доходят до руководства пользователя. Его часто отбрасывают, считая второстепенным или просто слишком сложным.
Избегайте внешнего вида учебника (альбомное форматирование может быть менее опасным).
Используйте бумагу, соответствующую качеству продукта.
Целенаправленно и эффективно используйте цвет.
Руководство пользователя не должно быть слишком большим, но для светодиодного светильника это один объем, а для станка с ЧПУ другой.
Эффективно используйте картинки и диаграммы.
Обеспечьте много белого пространства.
Включите номер службы поддержки.
Используйте язык, понятный для потребителя.
Очень важно, чтобы инструкции были легко читаемыми и понятными для всех пользователей. Многие руководства пользователя содержат инструкции, которые являются неполными, неправильными или просто не имеют отношения к фактическому продукту.
