2 ключевые характеристики хорошего гайда
1. Конкретный алгоритм действий по шагам.
В идеале должен получиться пошаговый «рецепт».
Каждый шаг включает только одно простое действие.
2. Конкретный результат.
Пользователь придерживается рекомендаций и достигает желаемой цели – быстрый завтрак, грамотный договор или красивую живую обложку.
без «воды», только «мясо»
Инструкция – это не философский труд,
здесь нужно писать только «по делу».
Вычеркните все эпитеты и рассуждения, которые не ведут к результату.
Проведите своего читателя из точки «было» в точку «стало» быстро и легко.
Наглядность – обязательное свойство
хорошей инструкции.
Добавляйте иллюстрации или скриншоты в текст, которые будут дублировать действия, описанные
в инструкции.
Если используете чужие картинки,
не забывайте про авторские права.
НО! Не добавляйте изображения
в инструкцию просто «чтобы было».
Котики в гайде неуместны.
Всё, что вы пишите в гайде, должно
отражать личный опыт. Если автор сам
не прошел шаг за шагом свою
инструкцию – не факт, что читатель сможет её пройти.
На пути из точки А в точку В может быть непреодолимая стена или перепутана последовательность действий.
Точной структуры для гайда нет, но общие правила всё-таки есть:
♦ краткое описание
♦ четкое деление по шагам
♦ маркированные списки
♦ иллюстрированные действия
После того как гайд будет написан, перечитайте его, проверьте на ошибки и опечатки.
Повторите всё, что написали самостоятельно, попробуйте взглянуть глазами пользователя.
В идеале можно привлечь знакомых или друзей дойти до результата
с помощью вашей инструкции.
Единого стандарта для гайдов нет.
Классная и полезная инструкция у вас
получится, если вы сами прошли каждый
её шаг, учли допущенные ошибки
и получили результат. Если искренне
хотите помочь другим пройти этот путь
не наступая на ваши грабли.
инструкции по созданию инструкций нет!