Forest st., Moscow
+79266800080

Как правильно писать гайды

Как правильно писать гайды

Гайд – это инструкция, руководство, эдакий план действий. В нем описывается порядок действий для достижения конкретного результата. Соответственно, он должен быть максимально понятен и полезен рецепиенту.

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

Требования к гайду

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

  • Четкий алгоритм. Вообще, гайды можно использовать не везде. Лучше всего они подойдут там, где процесс идет по каким-либо этапам. В идеале должен получиться пошаговый «рецепт». Каждый шаг, конечно же, включает только одно простое действие.
  • Описание конкретного результата. Нужно точно представлять или хотя бы понимать, чего именно хочет достичь человек после прочтения вашего гайда. Основываясь на этих знаниях, вы даете точное направление «развитию сюжета».
  • Строго по факту. Фраза «без воды» никогда не была столь актуальной… Люди хотят решить свою проблему, и им не всегда нужны какие-либо философские рассуждения или углубления в прилегающую сферу. Просто путь из точки А в точку Б, грубо говоря. В крайнем случае можете дать ссылку на другой источник, где подробнее описываются детали какого-либо этапа. 
  • Соответствие уровню знаний читателя. Когда вы садитесь писать материал, то четко представляете, для кого именно он предназначен. Важен четкий образ: это может быть чайник, который решил освоить что-то новое, профи, пожилой человек, школьник и так далее. Отсюда следует, что чем меньше уровень осведомленности аудитории в затрагиваемой сфере, тем подробнее инструкции. А ежели вы не знаете, кому пишете, и делаете это просто для галочки, то просто тратите свое время и время читателей.
  • Наличие иллюстраций. Будет не лишним, если весь процесс будет сопровождаться изображениями. Ежели это какая-то инструкция по компьютерам, то это скриншоты. Рецепт? Тогда фотографию процесса приготовления. Где-то может понадобиться видео, где-то и текст вообще ни к чему. Но если используете чужие картинки, не забывайте про авторские права.

Тут ведь еще важно не переборщить, не начать перечислять каждую мелочь или очевидные детали, дабы материал казался объемнее (или по другим причинам). Вставлять картинки ради забавы или красоты в гайдах не стоит. Вряд ли читателю понадобится какой-то мем или фото забавного котика.

Отличия гайда от обзора

Обзор – это рассмотрение самого продукта, его характеристик и каких-то качеств. А гайд – это инструкция по использованию с четко обозначенными действиями. Для описания сути обзора больше подходит слово «Что», а для гайда – «Как».

Как правильно написать гайд

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

Определение аудитории

Если вы пишете гайд для крупного ресурса, ориентируйтесь на его «стратегию». Посмотрите, какие материалы на нем публикуются и какие темы затрагиваются, как другие авторы объясняют пользователям те или иные детали. Отталкивайтесь от этого.

Другой вариант – спросите у читателей или клиентов. Будучи экспертом, вы с легкостью сможете определить их уровень знаний. Кстати, таким способом можно еще и определить, в каком стиле лучше излагать мысли.

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

Оптимальный объем

Его нет. Но есть теория, что чем короче гайд, тем лучше. На вкус и цвет… Главное, чтобы из материала (будь это хоть одно предложение или лонгрид) человек узнал, как действовать.

Личный опыт

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

Структура и оформление

Четкая последовательность действий, никаких неожиданностей и резких поворотов. Придерживайтесь пошагового принципа и старайтесь не уходить от него.

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

  • Краткое описание.
  • Когда нужно использовать инструкцию.
  • Описание работы по шагам.

Помните про обозначение шагов. Обозначайте разделы разными заголовками. Не делайте слишком длинные абзацы – оптимальный размер составляет от 3 до 7 строк.

Хотите что-то сравнить? Вставьте таблицу. Привязывайте к каким-то элементам полезные ссылки. Используйте списки, если идет перечисление, и не забывайте оформлять их маркерами или номерами.

Объяснения

Если вы в гайде что-то запрещаете, обоснуйте, дайте причины и разъяснения. Пользователь должен понять, по какой именно причине указанное действие недопустимо. Такое вполне можно отобразить в виде картинки, перечеркнутой красной линией или обозначенной словом «Неправильно».

Тест-драйв

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

Проверка

Если у вас нет редактора, проверять текст придется самостоятельно. Рекомендуется после написания отойти на некоторое время от текста, отвлечься, и на «свежую голову» перечитать материал. Полезно еще читать вслух – так вы поймете, не осталось ли спорных моментов.

После завершения вычитки проверьте текст в различных онлайн-сервисах. Первый пункт проверки – это антиплагиат. Вам поможет Text.ru, Etxt или Advego. Второй – грамотность. Здесь вам в помощь Главред, Орфограммка и ОРФО. Третий, если вы размещаете гайд на сайте и ориентируетесь на SEO, – это водность и тошнота текста.

Заключение

Как подтвердить полезность гайда? Если прочитавший его человек достиг нужного результата с помощью указанной последовательности. И сделал он это при одном прочтении, не открывая другие источники и не ища значений незнакомых ему терминов. Основной принцип гайда – простота.

источник

Related Posts
Leave a Reply