Как сделать мануал
Руководство — отличный пример эффективного контент-маркетинга. Гайды не только демонстрируют знания эксперта, но и приносят пользу людям. Сегодня расскажем о том, как их правильно писать.
Итак, начнем с того, что условно гайды делятся на два типа:
Первый вопрос — кто будет читать гайд? Руководство для новичков — это одно. Гайд для тех, кто уже умеет что-то делать и хочет прокачать скилл, — совсем другое.
Разница в подаче материала. Новичкам нужно все разложить по полочкам, подробно рассказать о каждом шаге, чтобы в конце у читателя не осталось вопросов. В руководстве для специалистов можно не рассказывать об очевидном. Например, интернет-маркетологи знают, в чем разница между CTR и CTA, поэтому им объяснять эти термины не надо.
Инструкции со множеством подробностей делают руководство объемным и громоздким. Новичкам, которые хотят вникнуть, придется окунуться в текст. Специалисты же не станут тратить время на давно известную информацию и поищут более лаконичный гайд.
Вот пример неудачного вступления:
Здесь есть вступление и нет воды, все четко и ясно. Чем короче гайд, тем он привлекательнее. При этом содержание должно быть емким, чтобы читатель узнал то, что хочет.
Очень много вступлений, речевых оборотов и т.д.
Вы уже решили, кто будет читать руководство, а теперь нужно подумать, на каком языке говорить с ЦА.
В гайде для дотеров можно смело пользоваться сленгом. Для этого достаточно почитать форумы, ознакомиться с парочкой видео и разобраться в терминологии.
В гайде о том, как сделать стяжку пола, тоже можно немного покуражиться. Маловероятно, что этот текст интересен трепетным филологическим девам, поэтому пара шуток или крепких словечек понравятся читателю.
Такие действия под запретом, иначе вы столкнетесь с непоправимым ущербом и понесете убытки.
Нарушите инструкцию - песец всему.
Звучит немного эпатажно, но доходчиво, и это отличает гайд от тысячи однотипных текстов. Конечно, такую прямоту оценят не все, но протестировать подобные приемы стоит.
Используйте списки. Надо что-то перечислить — делайте список, даже короткий, даже всего из трех пунктов.
Оформлять инструкции тоже нужно как список. Исключение — руководство с пошаговыми иллюстрациями, которые разбивают текст на части.
Чтобы что-то сравнить, создавайте таблицы.
Руководство без иллюстраций — это не руководство. Его даже не попытаются понять.
Вместо тысячи слов — картинка. Можно интересно писать, но лучше показывать. Например, вы рассказываете о каком-нибудь устройстве. На правой панели прибора в верхней части с левой стороны есть большая желтая кнопка, которую надо нажать. Что проще: объяснять словами или сделать фото и обвести кнопку кружком? Конечно, сделать фотографию.
Нет фотографий — есть YouTube. Найдите видео по теме, сделайте скриншот нужного кадра. Другой вариант — нарисуйте схему в графическом редакторе. Так, если вы пишете гайд по работе с компьютером, делайте много скриншотов. Удалить лишние скрины проще, чем обнаружить, что не хватает какого-то шага, и начинать все сначала.
Конечно, есть вещи, которые ни фотографиями, ни скриншотами не передать. Если надо объяснить, как правильно приседать или сделать потайной шов, поможет GIF-анимация.
Как тут не вспомнить главреда всея интернета Максима Ильяхова, который делает гифку из редактирования текста. Вот абзац, вот удаление лишнего, вот результат. Круто? Круто.
При желании можно создать видеогайд — альтернативу текстовому руководству. Кто любит читать инструкции, тот пусть читает, а кто предпочитает смотреть — пусть смотрит.
Не забудьте закончить руководство фотографией результата. Это важно для гайдов по готовке или рукоделию. Если стейк получился похожим на подошву, читатель вряд ли захочет повторить такой опыт.
Еще раз: гайд должен быть лаконичным. Это не перечисление всех терминов и определений. Однако информативность не должна страдать, поэтому используйте ссылки.
Особенно полезны ссылки на сайтах с разными руководствами. Перед автором задача — написать серию текстов о командной строке в Linux. Писать, как открывать строку в каждом гайде, — потеря времени. Можно вынести инструкцию в отдельный мини-гайд и на каждой странице добавлять ссылку на него. Красивое решение как с позиции SEO, так и с точки зрения юзабилити.
Этот рецепт работает и с полными руководствами. Не размещайте огромное текстовое полотно на одной странице, а разбивайте его на разделы с грамотной перелинковкой. Google и Яндекс именно так и устроили гайды для своих сервисов.
Контент в виде хорошего гайда работает — доказано практикой. Грамотное руководство с большой вероятностью окажется в ТОПе поисковых систем. Пользователи будут добавлять его в закладки, делать репосты, отправлять ссылки коллегам.
С помощью качественного гайда вы увеличите посещаемость сайта. А если напишете классное руководство для клиента, то он к вам обязательно вернется.
Что такое руководство пользователя и для чего его создавать
Ежедневно создаются новые продукты, программы, сервисы и часто пользователям приходится несладко при освоении какой-нибудь сложной программы, поэтому каждому новому продукту желательно собственное руководство. Для чего?
Большинство людей не хочет разбираться с чем-то незнакомым без персонального, всегда доступного и понятного помощника. А именно им и является хорошее руководство пользователя.
Общие советы по созданию пользовательской документации
Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать - рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.
После этого важно подумать о том:
- Где пользователь будет к нему обращаться: дома, на работе, в машине?
- Как часто он будет его просматривать?
- Насколько объективно сложен для понимания продукт?
Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым "справочником" или объемным "путеводителем" Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.
Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте - не сделает ли полное отсутствие терминов ваше руководство бесполезным?
Структура руководства пользователя
После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего "путеводителя" хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.
В первом разделе желательно рассказать общую информацию о программе:
- Для чего создан продукт.
- Какие задачи он решает.
- Какие основные выгоды от использования для клиента.
В следующем разделе можно указать основные элементы пользовательского интерфейса. Пользователю будет трудно разобраться в софте, если он не поймёт для чего служат различные элементы интерфейса, или он не разберётся в основных режимах работы ПО. Опишите понятным языком предназначение экранов и окон.
Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.
Ни одно руководство не обойдется без таких разделов как: "Частые вопросы" и "Устранение типовых проблем" В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.
Иногда технические писатели забывают о важном моменте в руководстве пользователя - контактная информация. Этот раздел поможет пользователям связаться с вами, даже если у них нет никаких вопросов и руководство полностью закрывает все их потребности. Клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.
Инструменты для быстрого создания руководства пользователя
Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.
Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс практически сам подскажет как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.
Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.
При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.
У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это - управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям - "Ctrl+c", Ctrl+v". Dr.Explain предлагает решение по повторному использованию контента - текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться - например, версия документируемой системы.
Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.
Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты - аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.
Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.
Почему компании выбирают Dr.Explain для создания руководств пользователя
Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы "Вега Матрица"
"Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное - она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.
Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу".
Прочитать полный кейс компании "Вега Матрица вы можете перейдя по ссылке
Наталья Обухова, бизнес-аналитик компании CRM Expert
Николай Вальковец, разработчик компании 2V
"Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт".
Прочитать кейс компании V2
Подытожим
Успешных вам разработок!
Смотрите также
СКАЧАТЬ
БЕСПЛАТНО
195 Mb, Windows 11/10/8/7 - 64 Bit
Информационный или продающий текст, насыщенный канцеляризмами, читать скучно и неинтересно: в обилии специфических слов и оборотов сложно понять суть, в результ.
Стиль текста
Ранее вы уже уточнили портрет целевой аудитории, осталось продумать стиль изложения информации для этих людей. Согласитесь, гайд по заливке фундамента и руководство по самостоятельному нанесению гель-лака в домашних условиях стоит писать по-разному.
В первом случае можно активно добавлять шутки или даже легкие ругательства (с этим будьте предельно осторожны, предварительно уточните у клиента, допустимо ли подобное). Когда пишете инструкцию по онлайн-играм для подростков, в текст можно добавлять сленг, это сделает его не таким сухим. Пишите просто, объясняя сложные моменты человеческим языком, но не пускайтесь в длинные описания очевидных вещей. Юмор в тексте приветствуется.
Без иллюстраций никуда
Нельзя представить полезное руководство, в котором нет поясняющих картинок. Гораздо наглядней добавить скриншот вместо длинного описания, где и что требуется нажать. Многие процессы просто невозможно описать без иллюстрации, например, как собрать бумажного журавлика.
С помощью картинки легко показать пошаговый алгоритм, результат и возможные ошибки. Примеры, картинки и диаграммы помогут пользователям увидеть процесс, легче усвоить информацию и понять, в каком месте они допустили ошибку.
Обязательно добавляйте тематические видео, это гораздо лучше, чем перегружать материал обилием изображений. Из видео на YouTube вы можете сделать поясняющие скриншоты самостоятельно или же вручную нарисовать схему в графическом редакторе. Главная ваша задача — чтобы читателю все было предельно понятно. Всегда учитывайте уровень знаний читателя, в противном случае рискуете тратить время на пояснение очевидных вещей, которые он и так знает.
Экспертность важна
Требования к контенту:
1. Полезный, решает проблемы ЦА.
2. Подробный, раскрывает нюансы и описывает этапы.
3. Наглядный, в нем достаточно инфографики, чек-листов и изображений.
4. Структурированный и легкий для восприятия.
5. Экспертный — автор должен хорошо понимать, о чем идет речь или писать на основании своего опыта.
Большинство копирайтеров — как начинающие, так и опытные, — сталкивались с ситуацией, когда на бирже размещен заказ на написание сильной экспертной статьи, но у.
Экспертность имеет ключевое значение, иначе гайд получится неточным. Получить нужный опыт вы можете самостоятельно, например, установив программу. Или же прибегните к опыту другого эксперта, который позже внесет правки в готовую инструкцию или дополнит ее примерами из практики.
Последовательность шагов
При работе соблюдайте последовательность шагов. Заранее подготовьте тезисный план с пошаговой инструкцией, где первый шаг — описание проблемы, а последний — ее решение. Промежуточными этапами будет подробный алгоритм действий. Не нарушайте логику, иначе инструкция окажется бесполезной и не применимой на практике.
Структура гайда
Инструкция почти всегда красиво форматируется при помощи списка. Исключение — когда после каждого шага идет поясняющий скриншот. Если требуется провести какое-либо сравнение, делайте его при помощи таблицы.
Самостоятельная проверка гайда
Самая простая проверка готового пошагового руководства — когда вы сами пытаетесь добиться результата, используя готовый текст. В идеале можно привлечь к этому друзей или людей, относящихся к целевой аудитории. Если они с легкостью решают проблему, пользуясь гайдом, вы достигли цели.
Дальше просмотрите инструкцию глазами обычного пользователя:
1. Все ли понятно или встречаются сложные термины.
2. Не пропущены ли важные пункты плана.
3. Соблюдается ли порядок этапов.
4. Нет ли ненужных подробностей, выбросив которые текст станет только лучше.
Обязательно проверьте статью на предмет опечаток, ошибок и тавтологии.
Заключение
Нет единого стандарта, следование которому поможет вам написать действительно классную и полезную инструкцию. Главное в процессе проработки такого материала — создать подробное, понятное, пошаговое руководство, которое решит проблему читателя. Если после прочтения ему удалось разобраться в настройках, приготовить блюдо или что-то отремонтировать, ваша инструкция написана правильно.
Регистрируйтесь, берите в работу статьи-инструкции, улучшайте и проявляйте свое мастерство — так вы найдете постоянных заказчиков и долгосрочные проекты на eTXT!
Скейтбординг сегодня стал довольно распространенным увлечением среди молодежи. Большинство людей привлекает красота захватывающих трюков, которые выполняют опытные мастера. За внешней легкостью и непринужденностью каждого из них стоят долгие тренировки. Основой многих трюков на сноуборде является мануал или баланс.
Мануал – движение скейтбордиста на доске только на задних колесах с поднятой вверх передней подвеской. Начинать обучение этому элементу лучше всего, стоя на месте, а позже пытаться двигаться и держать баланс.
Для начала выберите ровную поверхность для тренировок. Доска должна устойчиво стоять на земле. Займите исходное положение: одна нога стоит в области болтов, крепящих переднюю поверхность, а вторая – на хвосте скейтборда.
Попробуйте перенести центр тяжести, изменяя положение тела, так, чтобы передние колеса скейтборда поднялись вверх, а задняя часть доски при этом не касалась земли. Будьте осторожны: несмотря на кажущуюся легкость трюка, обучение ему может быть травмоопасным, поэтому не забывайте о защите.
Добившись нужного положения доски, попробуйте сохранить равновесие и продержаться так как можно дольше. Для того чтобы вам было легче балансировать, не держите ноги прямыми в коленях, а немного присядьте и раскиньте руки в стороны как можно шире – так делать мануал будет гораздо легче. Конечно, со стороны такой элемент не будет смотреться красиво и эффектно, но со временем вы привыкнете балансировать и без рук, а на начальном этапе такая поддержка очень полезна.
После того, как вам начнет удаваться долгое время держать баланс на месте, можете переходить к обучению мануалу в движении. Для этого также важна ровная поверхность, без склонов и препятствий. Встаньте на доску, оттолкнитесь несколько раз, чтобы разогнаться до наиболее комфортной для вас скорости, и, перенося центр тяжести на заднюю часть доски, повторите те же действия, которые вы научились делать, стоя на месте. Важно на этом этапе не заваливаться назад и не сковывать своих движений, нужных для того, чтобы держать баланс. После нескольких тренировок вы научитесь без особого труда выполнять этот элемент, после чего можно тренироваться другим трюкам.
Читайте также: