Обзор Наши банальные, стерильные заголовки и манера письма мало способствуют тому, чтобы наши Пользователи читали те части документации по продукту, которые были бы для них особенно полезны.
В этой статье представлены два реальных примера того, как они подводят своих пользователей и как исправить проблемы.
Не юридические вопросы и отказ от ответственности Хотя разделы «Юридические вопросы» и «Отказ от ответственности» вашей документации важны для защиты вашей компании (а защита вашей компании должна быть основной целью вашей работы), мы здесь говорим не об этом.
Вместо этого мы обсуждаем темы Документа, которые часто упускаются из виду, но которые важны для ваших пользователей.
Мы рассмотрим два примера, в которых автор документа должен подтолкнуть читателя к изучению дополнительного материала.
Мое предложение состоит в том, чтобы «рекламировать» темы, используя заманчивое письмо, чтобы побудить Пользователя прочитать соответствующие темы.
Правило (писательной) жизни Если Пользователь знает один способ сделать что-то, он/она не решается изучать другие способы.
Вы, как автор документа, должны убедить читателя в преимуществах «другого» (лучшего) пути.
Пример: стили Microsoft Word (tm) Большинство опытных пользователей Microsoft Word (tm) для форматирования своих документов используют «стили», а не ручное форматирование.
Новые и случайные пользователи не знают об этом мощном инструменте (доступном в большинстве текстовых процессоров).
Пользовательская документация Word мало что делает для того, чтобы побудить Пользователя узнать о стилях.
Пользовательский документ Word рассказывает о ручном форматировании символов, абзацев и т. д. Далее в документе есть раздел «стили».
Но зачем Пользователю читать этот раздел? Стили кажутся просто еще одним способом форматирования символов, абзацев и т. д. В разделе форматирования просто рассказывается, как это сделать.
Опытные пользователи знают, что для писем длиной более нескольких страниц стили дают множество преимуществ.
Документер: Продавайте Ридеры по важным темам! Поощряйте своего Пользователя читать дополнительные материалы.
Microsoft следовало бы добавить что-то вроде этого в конце раздела о ручном форматировании: «Мы рекомендуем вам использовать «стили» для форматирования любых документов, длина которых превышает несколько букв.
См.
главу XX, чтобы узнать о стилях».
Пример: безопасное отключение газового барбекю Заголовок документа пользователя газового барбекю гласит: «Как выключить барбекю».
Читатель думает: «Я знаю, как это сделать», и не читает материал.
Если ваши пользователи делают что-то небезопасно или неправильно, то этот мягкий заголовок не поможет им исправить свои действия.
Давайте попробуем более убедительный заголовок для этого: «Большинство людей небезопасно выключают барбекю: вот правильный способ» Или еще более сосредоточенно: «Возможно, вы небезопасно выключили барбекю: вот правильный способ» Эта формулировка звучит так, будто вы продаете продукт Пользователю.
Но вы не.
Вы используете маркетинговые методы, чтобы заставить пользователей прочитать важный материал.
Кстати: если у вас есть газовый гриль, сравните то, как в инструкции вам советуют его выключать, и то, как вы на самом деле выключаете гриль.
«Смотри также» слишком банально Не попадайтесь в ловушку, просто добавляя разделы «Смотри также», где это необходимо.
Они подходят для того, чтобы сообщить читателю, где найти дополнительную информацию, но не помогут убедить вашего читателя прочитать важный дополнительный материал.
Если материал приносит читателю реальную пользу, продайте ему его, прочитав.
Сравните это: См.
также: Стили, глава XX. Мы рекомендуем использовать «стили» для форматирования любых документов, длина которых превышает несколько страниц.
См.
главу XX, чтобы узнать о стилях.
Если бы вы читали Пользовательский документ, какой из двух приведенных выше заголовков помог бы вам узнать о стилях? (Если вы дали «неправильный» ответ, спросите других людей;-) Нижняя линия Предлагая Reader то, что вы (или ваши эксперты в данной области) считаете важным (помимо юридических положений и заявлений об отказе от ответственности), вы добавляете в документ свои знания.
По сути, вы говорите: «Я думаю, вам следует прочитать эту тему, потому что она может вам помочь».
Это хорошо, особенно потому, что это отражает ваше хорошее отношение к вашему Читателю.
Введение
Когда дело доходит до технического письма, недостаточно просто предоставить информацию. Чтобы по-настоящему привлечь читателей и обеспечить им пользу от вашей документации, вам необходимо продавать им то, что важно. Это означает, что нужно выйти за рамки сухого и бесплодного языка и использовать методы убеждения, чтобы побудить пользователей изучить важные темы. В этой статье мы рассмотрим два реальных примера, когда техническое письмо не может привлечь внимание читателей, и обсудим стратегии по исправлению этих проблем.
Выходя за рамки юридических требований и отказов от ответственности
Хотя юридические разделы и разделы об отказе от ответственности необходимы для защиты вашей компании, они не являются предметом нашего обсуждения здесь. Вместо этого мы углубимся в часто упускаемые из виду темы документов, которые имеют значение для ваших пользователей. Это области, в которых технические писатели должны подталкивать читателей к изучению дополнительного материала. Используя привлекательные приемы написания, мы можем побудить пользователей читать соответствующие темы и извлечь максимальную пользу из документации.
Правило (писательной) жизни
Пользователи склонны придерживаться того, что знают, часто не решаясь изучить альтернативные методы. Как составитель документов, вы обязаны донести до читателей преимущества альтернативных подходов. Давайте рассмотрим пример со стилями Microsoft Word.
Пример: стили Microsoft Word
Большинство опытных пользователей Microsoft Word полагаются на «стили» для эффективного форматирования документов. Однако новые и случайные пользователи могут не знать об этом мощном инструменте. К сожалению, пользовательская документация Word мало что дает пользователям для изучения стилей. В документе сначала обсуждается ручное форматирование символов и абзацев, а затем вводится понятие стилей. Однако без убедительных формулировок пользователи могут задаться вопросом, зачем им читать этот раздел. В конце концов, раздел форматирования просто научил их выполнять одни и те же задачи.
Документеры: продавайте читалку по важным темам!
Крайне важно донести до читателей важные темы и побудить их изучить дополнительный материал. В случае с Microsoft Word документ мог бы включать убедительное заявление в конце раздела ручного форматирования, например:
«Мы рекомендуем вам использовать «стили» для форматирования любых документов, длина которых превышает несколько страниц. См. главу XX, чтобы узнать о стилях».
Используя убедительный язык, вы можете побудить пользователей углубиться в жизненно важные темы, которые повысят их опыт и производительность.
Пример: безопасное отключение газового барбекю
Рассмотрим документ пользователя газового барбекю с заголовком: «Как выключить барбекю». Этот заголовок не может увлечь читателей, поскольку они могут предположить, что уже знают процесс, и пропустить материал. Однако если пользователи практикуют небезопасные или неправильные процедуры завершения работы, простой заголовок не сможет исправить их поведение. Вместо этого попробуйте более убедительный подход:
«Большинство людей небезопасно выключают барбекю: вот правильный способ»
Или еще более сосредоточенно:
«Возможно, вы небезопасно выключили барбекю: вот правильный способ»
Эти привлекающие внимание заголовки используют маркетинговые приемы, чтобы привлечь читателей и побудить их изучить важную информацию о безопасности.
Выход за рамки «Смотри также»
Просто добавить раздел «Смотри также», чтобы направить читателей к дополнительной информации, недостаточно. Хотя он служит руководством для пользователей, ему не удается убедить их прочитать материал. Чтобы действительно продать читателям важный дополнительный контент, сравните следующие подходы:
- См. также: Стили, глава XX.
- Мы рекомендуем вам использовать «стили» для форматирования любых документов, длина которых превышает несколько страниц. См. главу XX, чтобы узнать о стилях.
Второй заголовок выходит за рамки простой ссылки и активно рассказывает читателю о преимуществах изучения стилей. Используя убедительный язык, вы можете эффективно привлечь читателей и мотивировать их к изучению ценного контента.
Нижняя линия
Используя методы убеждения, чтобы донести до читателей то, что вы или ваши эксперты в данной области считаете важным, вы повышаете общее качество своей документации. Это демонстрирует вашу приверженность потребностям читателей и отражает позитивное отношение к их успеху. Так что не уклоняйтесь от использования маркетинговых приемов в технических текстах — это мощный способ гарантировать, что ваши читатели извлекут максимальную пользу из вашей документации.
-
Акива Бен Йосеф
19 Oct, 24 -
Напишите Статью Практически Обо Всем
19 Oct, 24 -
Не Мой Сын
19 Oct, 24 -
Смысл Фильма Враг 2013
19 Oct, 24 -
Способы Лечения И Очищения Суставов Рисом
19 Oct, 24
