Как создать руководство

Практические руководства являются средством обмена сложными навыками, процессами и ценной информацией с большой аудиторией.

Они необходимы в каждой области, от искусства и ремесленных проектов до технологий.

Практическое руководство поможет успешно поделиться своими навыками и опытом с читателями, которые ищут направление для различных задач.

Что такое руководство?

Руководство с практическими рекомендациями — это информативный письменный документ, описывающий процесс от начала до завершения с использованием серии пошаговых инструкций.
Читатели практических руководств часто ищут информацию о том, как выполнить задачу.
Руководства с практическими рекомендациями могут содержать инструкции по процессам из нескольких областей интересов, некоторые из которых включают:

Домохозяйство

Художественные и ремесленные проекты

Садоводство

Развитие карьеры
Развитие навыка

Путешествовать

Готовка или выпечка

Фитнес

Игры

Душевное здоровье

Технология

Коммуникация

Почему важны практические руководства?

Практические руководства — это важный способ поделиться ценной информацией о процессах, как простых, так и сложных.
Они предоставляют своим читателям возможности для обучения и развития навыков и могут предложить помощь во время сложных процедур.
Иногда они могут включать важную информацию о безопасности для задач с высоким риском или потенциально опасных задач, которые могут защитить благополучие их читателей.

Например, человек может использовать практическое руководство, чтобы узнать, как заменить шину или безопасно решить проблему с электричеством

Как создать руководство

1. Поймите свою целевую аудиторию
Прежде чем писать руководство, важно понять свою целевую аудиторию.
Приложите все усилия, чтобы подумать, кто может прочитать ваше руководство и почему.
Учитывайте их возраст, биографию, уровень знаний по предмету и другие демографические данные, чтобы определить важные аспекты вашего руководства.
Ваша целевая аудитория и ее мотивы могут повлиять на язык, используемый в вашем руководстве, на количество и сложность шагов, а также на информацию, которая считается необходимой для завершения процесса.

2. Изучите процесс
Важно, чтобы вы полностью понимали процесс при написании учебного руководства. Если вы не знакомы с этим процессом, подумайте о том, чтобы изучить его как можно больше, прежде чем начинать руководство. Вы можете сделать это, читая другие практические руководства, просматривая обучающие видео, практикуя процесс самостоятельно или читая книги и литературу, доступные по этому вопросу. Глубокое понимание процесса может помочь вам включить всю важную и точную информацию, необходимую для успешного завершения.

Даже если у вас уже есть знания об этом процессе, может быть полезно провести небольшое исследование, чтобы освежить вашу память и обновить ваши методы.

3. Определитесь с названием
Подумайте, какое название вы хотели бы использовать для своего практического руководства. Эффективное название часто кратко резюмирует процесс, который призвано описать ваше руководство, и начинается с «Как сделать». Попробуйте использовать жирный, легко читаемый шрифт для заголовка и отцентрируйте его в верхней части страницы. Например, вы можете назвать руководство по ловле рыбы «Как поймать рыбу».

4. Создайте действенные шаги
Как только вы полностью поймете процесс и напишете свой заголовок, вы можете приступить к написанию шагов своего практического руководства. Во-первых, рассмотрите количество шагов, необходимых для четкой передачи всех инструкций. Затем назначьте каждому шагу подзаголовки или заголовки, обобщающие их содержание. Затем напишите свои инструкции для каждого шага как можно яснее и проще. Подумайте, насколько действенным является каждое из ваших описаний, ведь иногда простое указание кому-то что-то сделать не дает ему необходимых для этого инструментов. Возможно, вам придется предложить варианты того, как они могли бы выполнить задание.

Например, вместо того, чтобы сказать «проведите небольшое исследование», вы можете сказать: «получите доступ к онлайн-ресурсам, таким как поисковые системы и обучающие видеоролики, для проведения исследований».
5. Упростите свой язык
6. Включите примеры
7. Включите дополнительные советы
Если есть дополнительная информация или полезные сведения о вашем процессе, которые не вписываются последовательно в ваши пронумерованные шаги, вы можете включить краткий список дополнительных советов в конце своего практического руководства. Рассмотрите информацию, которая была полезна, когда вы завершили процесс, информацию, полученную в ходе вашего исследования, или любой другой важный контент, который может быть полезен читателю. Количество советов, которые следует включить, может зависеть от темы и сложности вашего руководства, но старайтесь, чтобы ваш список не превышал пяти пунктов, чтобы улучшить читабельность.
Используйте активные глаголы
Активные глаголы помогают сделать ваше письмо более прямым и понятным, определяя действующее подлежащее в предложении. Подумайте о том, чтобы проверить свое руководство на наличие случаев пассивных глаголов и пересмотреть их, чтобы отразить действительный залог.

Например, вместо того, чтобы говорить «Затем блоки складываются в башню», попробуйте «Затем вы можете сложить блоки в башню».

Сосредоточьтесь на теме
Иногда может возникнуть соблазн использовать юмор или развлечение, чтобы сделать руководство более приятным для чтения. Хотя вы можете использовать свою собственную точку зрения и стиль письма, важно не забывать оставаться в теме и избегать шуток или не относящихся к делу комментариев, чтобы предотвратить путаницу и неправильное толкование ваших инструкций.
Заключение

Контент в виде хорошего гайда работает — доказано практикой. Грамотное руководство с большой вероятностью окажется в ТОПе поисковых систем. Пользователи будут добавлять его в закладки, делать репосты, отправлять ссылки коллегам.

С помощью качественного гайда вы увеличите посещаемость сайта. А если напишете классное руководство для клиента, то он к вам обязательно вернется.
Контент

И так, мы создали «каркас» нашей документации, но чтобы руководство стало полезным нужно наполнить её компетентной информацией.

Конкретного совета дать невозможно, так как все продукты разные. Поэтому расскажу про общие положения, которые делают документацию лучше.

1. Понятность.

Помните, что руководство будут читать люди, которые не сильно знакомы с вашим продуктом. Пишите простым языком, избегайте профессиональных терминов. Руководство пользователя должно быть написано на языке этого самого пользователя, а не на языке писателя.

2. Наглядность.

Добавляйте в руководство побольше графики и скриншотов с аннотациями. Читателю будет проще и приятнее решать проблему, если будет наглядно показано как это делать.

3. Видео.

Лучше один раз увидеть, чем сто раз услышать. Продемонстрируйте пользователю последовательность действий для достижения конкретной цели. Документация, содержащая видео вставки будет пользоваться большей популярностью, чем обычный текстовый документ.

Но как добавить в документацию видео? Смотрите ниже.

Больше советов!

Когда документация будет готова, чтобы она стала «полноценной» её нужно опубликовать. Иначе какой от неё толк, если клиент не может её прочитать. У «юзера» всегда должен быть доступ к документации, и не важно где он. Такую потребность легко закрывают три формата: HTML, PDF и CHM.

Создайте файл справки и загрузите его прямо в вашу программу в формате CHM. Таким образом, у пользователя будет возможность открыть документ, не выходя из программы. Не забудьте добавить элемент вызывающий руководство в меню программы.

Выложите руководство на сайт в формате HTML, чтобы клиент мог обратиться к документации, даже не работая с программой. Кроме того, документация, выложенная на сайт, повышает SEO факторы сайта.

И напоследок, переведите пользовательскую документацию в формат PDF, чтобы клиенты могли скачать и распечатать руководство.

Но помните, что после публикации документации, придется иногда её обновлять.

Инструменты

Для того, чтобы написать, а затем опубликовать документацию одного Wordа не хватит, но и пользоваться большим количеством программ тоже не хочется.

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

Dr.Explain – программа для создания руководств пользователя для ПО, web-сервисов и баз знаний.

Благодаря «доктору» вы сможете опубликовать и обновлять документацию в востребованных форматах (CHM; HTML; PDF; DOC), не выходя из программы.

В программе есть шаблоны документации, ведь по образцу работать проще.

Импортируйте в программу заранее написанные фрагменты документации.

Вы сможете создать контекстно-зависимую документацию, настроить визуальный стиль руководства, добавить в него видео и многое другое

Дорогой друг!