Содержание
- Поставьте себя на место читателя
- Что вам нужно знать о своих читателях
- Ваши читатели уже разочарованы
- Примечание перед тем, как вы начнете писать инструкции
- Магическая формула написания инструкций
- Волшебная формула: данный новый метод
- Теперь вы готовы писать хорошие инструкции
- Заключительная уборка
- Юзабилити Проверьте свои инструкции
- Выводы и обобщения.
Лаура - технический писатель. Ей нравится играть на пианино, путешествовать, изобразительное искусство и делать украшения.
Поставьте себя на место читателя
Чтобы лучше написать инструкции или процедуры для компьютера, вы должны сначала поставить себя на место читателя или пользователя.
Пользователь ничего не знает о вашем веб-сайте или программном обеспечении и не будет (и не должен) тратить время на то, чтобы прочитать весь набор инструкций, прежде чем начать свою работу. Пользователь просто использует ваш продукт для достижения какой-то своей цели (совершить покупку, найти информацию и т. Д.).
Что вам нужно знать о своих читателях
Перво-наперво. Вы должны принять тот факт, что ваши читатели, скорее всего, не хотят читать то, что вы написали. Это означает, что для написания эффективных и полезных инструкций вам сначала нужно принять все следующие истины:
- Ваши читатели / пользователи не хотят узнавать, как пользоваться вашим продуктом / услугой; они хотят выполнить какую-то задачу или цель самостоятельно.
- Они читают документацию только в отчаянии после того, как то, что они пытались сделать, потерпело неудачу.
- Теперь они разочарованы.
- Они не знают, как действовать для достижения своей цели / задачи.
Ваши читатели уже разочарованы
Как составитель инструкций, вы начинаете с плохой ситуации, потому что пользователи (которых вы, вероятно, не знаете и никогда не встретите) уже разочарованы вашим продуктом / услугой к тому времени, когда они обратятся к инструкциям, которые вы написали. как выполнить каждую задачу. Так что будьте добры к ним и дайте им четкие, краткие, окончательные и точные инструкции, которые вернут их на путь к достижению своей цели как можно быстрее: это форма хорошего обслуживания клиентов!
Шаблон становится довольно простым и применим к большинству типов пошаговых инструкций, а не только к компьютерным инструкциям.
Примечание перед тем, как вы начнете писать инструкции
Прежде чем приступить к написанию инструкций, необходимо знать, в каком стиле они должны быть написаны.
Попросите у кого-нибудь «Руководство по стилю дома» (отдел маркетинга - хорошее место для начала) и получите последнюю копию Руководства Microsoft по стилю для технических публикаций.Но как насчет пользователей Apple Macintosh? Они либо уже знакомы со стилем письма Microsoft, либо они не будут сбиты с толку, потому что вы будете последовательно реализовывать этот стиль письма на протяжении всего руководства по эксплуатации.
Словарь и тезаурус тоже никогда не повредят, хотя их также можно найти в Интернете, и какой из них следует использовать, следует указать в Руководстве по стилю дома. В случае сомнений используйте Merriam Webster, «золотой стандарт» словарей.
Магическая формула написания инструкций
| Где я? | Что мне делать? | Что случилось? |
|---|---|---|
Расскажите читателю, где они → | Скажите им, что делать → | Опишите результаты своих действий |
Волшебная формула: данный новый метод
Теперь вы знаете одну из основ технического общения, независимо от того, являетесь ли вы профессиональным писателем. Он также известен как метод «данное-новое», потому что вы начинаете с того, что рассказываете читателю то, что он уже знает, «данное», а затем даете ему что-то «новое». Четкие заголовки / заголовки - вот ключ к успеху.
Обратите внимание, что этот метод помогает уже разочарованному читателю / пользователю быстро понять, применима ли ваша конкретная процедура к их ситуации, потому что вы дали ей четкое название, находятся ли они в правильном стартовом месте (потому что вы сказали им, с чего начать), с чего начать. сделать в этот момент, и как должны выглядеть результаты.
Теперь вы готовы писать хорошие инструкции
Теперь, когда вы знаете правила написания, вы можете начать писать инструкции, всегда учитывая точку зрения пользователя.
Вы называете инструкции «Как выполнить задачу ABC», следя за тем, чтобы все инструкции под этим заголовком имели отношение к выполнению задачи ABC (и ни к чему другому). Теперь вы готовы писать сами инструкции.
Первое, что нужно сделать, - это сориентировать пользователей: рассказать пользователям, где они находятся и что они должны видеть на своем экране, например, название окна, в которое они должны смотреть. Затем сообщите им, какие кнопки нужно нажать в текущем окне и / или какой текст им нужно ввести в какое поле (поля). Затем расскажите им, как перейти к следующему шагу / местоположению, и опишите, что они должны видеть на экране, когда они выполнят это действие.
Например:
- От Главное окно, выберите все параметры, которые вы хотите активировать. Нажмите ОК. В Второе окно отображается текущий статус выбранных вами опций.
- На Второе окно, убедитесь, что все выбранные параметры верны.
- Если все параметры верны, нажмите Активировать параметры. В Третье окно появляется.
- Если не все параметры верны, щелкните Назад вернуться к Главное окно и выберите разные варианты.
Заключительная уборка
Когда вы закончите писать, запустите программу проверки орфографии и грамматики, а затем попросите одного или нескольких профильных экспертов (SME) - людей, знакомых с продуктом - просмотреть документ. Внесите любые изменения, повторно запустите средство проверки орфографии и грамматики и попросите кого-нибудь вычитать / отредактировать документ.
После того, как вы ввели какие-либо изменения, внесенные редактором, обычно все готово (если у вашей компании нет формального процесса выпуска документов, которому вы должны следовать).
Обратите внимание, что изменения, внесенные профильными экспертами и редактором (экспорт предмета с точной формулировкой и стилем), должны быть приняты почти без вопросов: это их работа, чтобы знать свою область знаний. если ты сильно не согласен с изменением, только затем доведите его до сведения SME или редактора, в зависимости от обстоятельств. В противном случае внесите предложенные изменения.
Юзабилити Проверьте свои инструкции
Когда у вас будет очень хороший черновик, наймите нескольких человек для проверки ваших инструкций - чтобы они прошли их от начала до конца и отметили (и позволили вам отметить) любые области, в которых они теряются или запутываются, или где инструкции неверны.
В идеале юзабилити-тестеры должны быть реальными покупателями / пользователями продукта / веб-сайта, которые вы задокументировали. Однако в крайнем случае нанять несколько человек из офиса, незнакомых с тем, о чем вы писали, и попросить их протестировать документ - это лучше, чем ничего. В этом случае обратите внимание, что тестировщики являются пользователями-экспертами в определенной области, поэтому их изменения столь же ценны, как и изменения, внесенные вашим продуктом SME и редактором (SME).
Само по себе юзабилити-тестирование - это целая дисциплина, которую невозможно описать в этой статье.
Однако, как только вы внесли изменения в тестирование юзабилити, пропустите их через редактор и, если применимо, через SME вашего продукта / услуги: возможно, небольшое изменение продукта / услуги, будь то сейчас или в будущей версии, будет иметь огромное значение. пользователям.
Выводы и обобщения.
По поводу написания программных инструкций можно сделать следующие выводы и обобщения:
- Читатели разочаровываются, когда читают вашу работу.
- Вам нужно успокоить читателя, рассказав ему, где он, что делать и где он окажется.
- Вам необходимо, чтобы эксперты рассмотрели ваш документ на предмет точности продукта, а также правильности написания.
- Вам необходимо принять изменения, внесенные вашими экспертами, если вы существенно не согласен, и в этом случае поговорите с соответствующим экспертом по проблеме.
- Юзабилити-тестирование - лучший способ убедиться, что ваш документ будет успешно удовлетворять потребности пользователей / читателей. Это может даже привести к улучшению продукта!
Эта статья точна и правдива, насколько известно автору. Контент предназначен только для информационных или развлекательных целей и не заменяет личного или профессионального совета по деловым, финансовым, юридическим или техническим вопросам.
