Загрузить PDF
Загрузить PDF
Руководство пользователя — это справочник на бумажном или цифровом носителе (в формате PDF или XPS), в котором приводятся инструкции по эксплуатации чего-либо или описывается правильный порядок действий для совершения какого-нибудь процесса. Хотя когда человек слышит словосочетание «руководство пользователя», он обычно представляет руководство по использованию определенной программы, инструкции по эксплуатации есть у компьютерной и бытовой техники (телевизоры, стерео-системы, телефоны, мп3-плейеры, садовая техника и и т.д.). Хорошее руководство пользователя рассказывает об основных функциях прибора или программы и объясняет, как правильно ими пользоваться, при этом информация обычно хорошо структурирована. Эта статья расскажет, о чем важно помнить при создании и оформлении руководства пользователя.
-
Чтобы создать хорошее руководство пользователя, нужно понимать, какой человек купит то устройство, к которому вы создаете инструкцию. Можно записать свои мысли, а можно просто представить себе этого человека. Это полезно делать, если вы работаете в команде по созданию документации и если вы участвуете в разработке продукта от самого начала до конца. Подумайте о следующем:
- Где человек будет пользоваться инструкцией по эксплуатации: дома, на работе, в машине, в интернете? Это определит не только содержание, но и стиль документации.
- Как человек будет пользоваться инструкцией? Если человеку потребуется лишь изредка заглядывать в руководство пользователя, значит, инструкция должна быть оформлена в сжатой форме. Если руководством будут пользоваться часто, особенно в самом начале, вам следует включить целый раздел о том, как начать пользоваться устройством или программным продуктом, и подробно описать все самые важные функции.
- Как много опыта должно быть у человека? Если ваш товар относительно новый или существенно отличается от похожих товаров, вам нужно будет включить информацию о том, чем этот товар отличается от аналогов, и предоставить пользователю подробные инструкции. Если товар связан с частыми проблемами (например, с большим количеством программ), опишите, что следует делать, когда проблема возникнет.
-
Если только ваш товар не предполагает наличие узких знаний у пользователя, лучше избегать технических терминов и описывать все простым, понятным языком. Структура текста должна соответствовать последовательности вопросов, которые могут возникать у пользователя. Правильнее группировать функции прибора в зависимости от задач, которые он выполняет, и отказаться от идеи объединения в одну группу самых популярных функций.
- Иногда полностью исключить технические термины невозможно (например, если вы составляете инструкцию к программе для создания графиков и диаграмм, где помимо стандартных средств также используются графические инструменты Фибоначчи). В этом случае полезно дать определение термину и краткое описание (то есть что такое графики Фибоначчи и как они используются в анализе финансовых показателей).
-
Опишите проблему, с которой может столкнуться пользователь, а затем предложите решение. Когда вы рекламируете какой-то продукт, фразы о том, как он сможет решить определенную проблему, несомненно привлекут много внимания. Но когда пользователь купит этот продукт, ему нужно объяснить, что с ним делать. Опишите, с какими проблемами может столкнуться пользователь в процессе эксплуатации, и включите в руководство инструкции по разрешению этих проблем.
- Если проблема сложная, разбейте ее на несколько частей. Составьте список и сопроводите каждый пункт инструкциями. Это называется разбивкой на блоки.
Реклама
-
Вам потребуется создать обложку, если инструкция занимает несколько страниц. Необходимо будет также оформить страницы с названием разделов для инструкций, где общее количество информации занимает более 4 страниц.
- Если руководство пользователя защищено авторским правом, соответствующее указание должно находиться на обложке и на страницах разделов.
- Если руководство пользователя предусматривает определенные условия использования продукта и инструкции к нему, разместите эту информацию с внутренней стороны обложки.
-
Если руководство состоит из нескольких брошюр, укажите все номера брошюр в начале. Кроме того, здесь также следует разместить раздел «Как использовать эту инструкцию по эксплуатации», если вы решили, что такой раздел необходим.
-
Если количество страниц превышает 10 штук, вам понадобится оглавление.
-
Основу руководства по эксплуатации должны составлять инструкции и информация о составных частях товара. Как правило, инструкции разбивают на блоки, и в каждом блоке можно указать, в каких разделах пользователю стоит искать ту или иную информацию. Так пользователю будет проще и быстрее находить нужные ему сведения.
- Процессы должны быть описаны четко и последовательно. Начните с общего описания задачи, затем объясните, что пользователю нужно будет сделать и какой результат он должен будет получить. Все шаги должны быть пронумерованы, а начинаться предложения должны с глаголов.
- Справочные материалы должны включать список функций, способы диагностирования неисправностей и часто задаваемые вопросы. В конце руководства пользователя можно разместить краткий словарь терминов и алфавитный указатель, хотя основные термины часто выносятся в начало. Алфавитный указатель рекомендован для инструкций, чей объем превышает 20 страниц.
-
Рисунки и скриншоты могут описать определенные процессы лучше, чем текст, особенно если речь идет от сложных процессах, где необходимо иметь визуальное подтверждение тому, что человек все делает верно. Графические изображения можно создать в специальных программах: в системах двух- и трехмерного черчения, в графических редакторах, в приложениях для обработки фотографий и т.д. Если необходимо сделать скриншоты, их можно получить с помощью штатных средств комьпютера и графической программы с возможностью сохранения скриншотов.
- После того, как получите графическое изображение, сохраните его в сжатом формате. Вам также может потребоваться уменьшить размер рисунка, чтобы он помещался на страницу, но размер не должен быть слишком маленьким, так как иначе пользователь не сможет рассмотреть, как и что следует делать. Если потребуется, можно разбить изображение на несколько частей и описать каждую из них.
- Если вы используете несколько изображений, они должны иметь одинаковый размер, пропорции и разрешение. Такие изображения будут более понятны и приятны читателю. При создании скриншотов убедитесь, что вы используете стандартную цветовую схему (для случаев, когда руководство печатается в цвете).
- Хотя графические редакторы (например, Photoshop и Paint Shop Pro) удобны для создания скриншотов, лучше пользовать специальными программами (например, SnagIt), поскольку они позволяют сразу же быстро и легко отредактировать, сохранить и подписать все изображения.
Реклама
-
Хотя компьютеры поддерживают разные шрифты, руководство пользователя должно быть хорошо читаемым, поэтому отдавайте предпочтение самым простым. Лучше всего подобрать несколько шрифтов, которые хорошо смотрятся вместе. Есть два типа шрифтов: с засечками и без засечек.
- У шрифтов с засечками есть небольшие черточки по краям линий. К таким шрифтам относятся Times New Roman, Baskerville и Book Antiqua. Такие шрифты подойдут большим объемам текста, напечатанного 10 или 12 размером и составляющего основу руководства пользователя.
- Шрифты без засечек имеют простые линии без украшений. Это такие шрифты, как Arial, Calibri и Century Gothic. Шрифты без засечек лучше смотрятся в текстах, напечатанных 8 или 10 шрифтом в руководствах в формате PDF или web-документа. Чем крупнее шрифт, тем сложнее его читать без засечек. Однако эти шрифты можно использовать и для крупного текста — например, для набора заголовков. Шрифты без засечек подходят для набора цифр в таблицах и колонках.
- Следует выбирать простые шрифты наподобие Arial или Times New Roman, хотя для цитат подойдет какой-нибудь более сложный шрифт. Если вы пишете руководство пользователя для фэнтезийной игры, можно выделить витиеватым шрифтом названия глав. Допускается также выделение цитат курсивом.
- После того, как выберите шрифты, создайте тестовую страницу, чтобы убедиться, что эти шрифты сочетаются между собой на бумаге. Покажите эту страницу человеку, который одобряет макеты, прежде чем отдать руководство пользователя в печать.
-
На этом этапе вам нужно решить, в каком порядке размещать информацию.
- Как правило, название руководства пользователя и названия глав размещаются сверху или снизу страницы вместе с нумерацией страниц. Цифры могут располагаться с внешней стороны (для верха и низа страницы) или по середине (для низа). Первая страница каждого раздела может отличаться от остальных, поэтому вы можете разместить номер ее страницы по середине снизу, а номера всех остальных страниц — с внешней стороны.
- Отдельные фрагменты текста можно выделить цветом, поместив их в специальные блоки. Важно выбрать такой оттенок, который не забивал бы текст.
- Оставьте достаточно большие отступы со всех сторон. Со стороны переплета отступ должен быть шире.
-
Если в вашем руководстве пользователя больше 4-х страниц, вам потребуется переплет. Документы для внутреннего пользования обычно скрепляют степлером в углу, но если вы будете вкладывать свое руководство в коробку с товаром, вам нужно будет подойти к этому вопросу более ответственно. Есть три типа переплета:
- Скрепление скобой. Этот тип подходит для брошюр размерами 21x 27.5 см, 21×35 см или 11 x 27.5×42.5 см. Большинство недорогих инструкций по эксплуатации, которые состоят из 48 страниц и менее, переплетаются таким образом.
- Переплет внакидку. Так переплетают большинство обычных инструкций по эксплуатации, не считая инструкций к автомобилям, хотя некоторые длинные руководства также переплетаются таким образом. (Paint Shop Pro изначально поставлялся именно с таким руководством пользователя.)
- Переплет с проволочной спиралью. Таким способом переплетают руководства, которые используются в более суровых условиях, например, на улице, где скобы могут с легкостью сломаться или разойтись. В некоторых инструкциях по применению с таким переплетом также встречаются ламинированные страницы, которые не промокают и не пачкаются в грязи.
-
В большинстве текстовых редакторов и программ для публикации текста в интернете предусмотрена возможность верстки. По мере того, как вы будете набирать текст, он будет автоматически отображаться в выбранном шрифте. (Эта статья была изначально написана с помощью шаблона в Microsoft Word.) В этих программах также есть уже готовые шаблоны, которые вы можете изменить с учетом своих потребностей, вместо того, чтобы создавать шаблон с нуля.
- В текстовых редакторах и программах для публикации текста в интернете также есть функция создания «стилей», сохранения шрифтов и задания размеров для оглавлений, колонтитулов и основного текста. Можно выбрать из уже существующих стилей («Заголовок1», «Обычный», «Цитата») или создать свой собственный стиль и дать ему свое название. Рекомендуется называть стили по такой же системе, как это предусмотрено в программе. (Например, Microsoft Word создает такие названия, как «Заголовок1», «Заголовок2»; кроме того, есть еще подзаголовки.) Настраивайте программу заранее, чтобы вам не пришлось возвращаться к этому, когда вы будете заниматься написанием текста.
Реклама
Советы
- По возможности пользуйтесь кодами полей или текстовыми переменными. Можно изменять их значения (например, название продукта, название главы руководства пользователя) и помещать их в документ в места, где вы обычно стали бы набирать слова вручную. Когда вы сделаете предпросмотр документа или подготовите его к печати, нужный текст подставится в переменные. Если изменится название товара либо если вы решите изменить название главы, вам будет проще поменять текст, заменив значение переменной.
Реклама
Что вам понадобится
- Текстовый редактор или программа для публикации текста в интернете
- Графический редактор или программа для создания скриншотов
Об этой статье
Эту страницу просматривали 55 879 раз.
Была ли эта статья полезной?
Должностная инструкция — это внутренний организационно-распорядительный документ, содержащий конкретный перечень должностных обязанностей работника с учетом особенностей организации производства, труда и управления, его прав и мер ответственности, а также квалификационные требования, предъявляемые к занимаемой должности.
Предназначение должностной инструкции
Должностная инструкция выполняет следующие задачи:
-
установление квалификационных требований, предъявляемых к определенной должности, выполняемой работе (образование, опыт работы, наличие специальной подготовки и т. п.);
-
определение должностных обязанностей работника (круг обязанностей, объем работы, участки, за которые отвечает работник, и т. п.);
-
установление пределов ответственности работника.
Таким образом, главное предназначение должностной инструкции — определение работнику круга его обязанностей, прав, ответственности.
Для каких целей используется должностная инструкция
Используя должностную инструкцию работодатель может:
-
доказать отказ в приеме на работу в связи с несоответствием соискателя (претендента на должность) установленным квалификационным требованиям, предъявляемым к определенной должности, выполняемой работе;
-
распределить трудовые функции между работниками;
-
оценить качество работы сотрудника в период испытательного срока;
-
оценить качество выполнения работником трудовой функции;
-
доказать несоответствие работника занимаемой должности или выполняемой работе вследствие недостаточной квалификации, подтвержденной результатами аттестации;
-
доказать правомерность применения к работнику дисциплинарного взыскания за неисполнение или ненадлежащее исполнение возложенных на него трудовых обязанностей.
Форма представления должностной инструкции
Должностная инструкция работника может быть представлена в двух вариантах:
1. Типовая должностная инструкция по конкретной должности, т.е. универсальная для всех работников по данной позиции. С ней все соответствующие работники знакомятся под личную подпись. Чтобы требования законодательства нарушены не были, необходимо должностные обязанности предусмотреть также и в тексте трудового договора.
При использовании этого варианта должностные обязанности работника в трудовом договоре должны быть аналогичны тем, которые перечислены в типовой должностной инструкции.
2. Должностная инструкция составляется отдельным документом (с указанием перечня должностных обязанностей, вопросами подчиненности, взаимодействия и т.д.) и оформляется приложением к трудовому договору. В таком случае в основном тексте договора может отсутствовать перечень должностных обязанностей, однако необходима ссылка на данное приложение.
Разделы должностной инструкции
Должностная инструкция обычно состоит из следующих разделов:
-
общие положения;
-
основные задачи и функции;
-
обязанности;
-
права;
-
ответственность;
-
взаимосвязи.
Общие положения
В первом разделе должностной инструкции «Общие положения» указываются:
— должность в соответствии со штатным расписанием и основные сведения о ней:
— название структурного подразделения, подчиненность данного работника, категория персонала;
— порядок назначения и освобождения от должности в соответствии с нормативными правовыми актами организации;
— порядок замещения этой должности в период временного отсутствия работника;
— требования к профессиональной подготовке (уровень образования, стаж работы), требования к квалификации;
— требования к знаниям работника;
— перечень нормативных документов, которыми работник должен руководствоваться в своей деятельности. В этот перечень включаются:
-
действующее законодательство РФ;
-
локальные нормативные акты работодателя, непосредственно связанные с трудовой деятельностью работника;
-
приказы и распоряжения руководителя организации;
-
непосредственно должностная инструкция;
-
другие документы.
Основные задачи и функции
Во втором разделе «Основные задачи и функции» должностной инструкции указывается основная задача работника в данной должности, участок работы.
Далее расписываются конкретные виды работы, которые сотрудник должен выполнять для достижения основной задачи.
Обязанности
В разделе «Обязанности» должностной инструкции указываются условия, которые должны соблюдаться работником при выполнении своих функций.
Например, работник должен соблюдать:
-
установленные сроки подготовки документов;
-
этические нормы общения в коллективе;
-
правила внутреннего трудового распорядка;
-
конфиденциальность служебной информации.
Права
В разделе «Права» описываются права, необходимые работнику для осуществления возложенных на него обязанностей, а также расписывается порядок осуществления этих прав.
В этом разделе указываются право работника:
-
на самостоятельное принятие решений;
-
на получение информации, в том числе конфиденциальной, которая необходима работнику для реализации его функций и эффективного исполнения обязанностей;
-
требовать выполнения определенных действий, давать распоряжения и указания и контролировать их исполнение;
-
визировать, согласовывать и утверждать документы конкретных видов.
Ответственность
В разделе «Ответственность» указываются виды ответственности работника за несоблюдение требований должностной инструкции и других локальных нормативных актов работодателя, за результаты и последствия своей деятельности, а также за неприятие своевременных мер или действий, относящихся к его обязанностям.
Согласно Трудовому кодексу РФ ответственность бывает материальной, дисциплинарной, административной и уголовной.
Взаимосвязи
В разделе должностной инструкции «Взаимосвязи» записывают порядок взаимодействия работника с другими структурными подразделениями и должностными лицами.
Порядок утверждения должностной инструкции
Должностные инструкции разрабатываются отделом кадров и подписываются руководителем службы делопроизводства.
При этом должностные инструкции могут быть согласованы с руководителями тех структурных подразделений, в которых работает сотрудник.
После этого должностные инструкции утверждает руководитель организации.
После утверждения должностной инструкции с ней следует ознакомить работника, принимаемого на должность (профессию).
Свою подпись работник может поставить:
-
на отдельном листе ознакомления, являющемся неотъемлемой частью инструкции;
-
в специальном журнале ознакомления с должностными инструкциями по форме, утвержденной в организации;
-
на самой инструкции в соответствующей графе;
- иными способами, принятыми в организации и не противоречащими законодательству.
Гайды, инструкции и пошаговые руководства — как собрать стеллаж, как выбрать гель для мытья посуды, как стать маркетологом — всегда актуальный и полезный контент. Они используются повсеместно, подходят для разных тем, площадок и ЦА.
Рассказываем, как правильно написать инструкцию или составить пошаговое руководство, чтобы материал был экспертным и приносил пользу людям.
Где использовать статьи-инструкции
Пошаговые руководства и инструкции всегда остаются востребованными. К ним обращаются, чтобы решить вопросы, связанные с обустройством дома или карьерой, здоровьем, увлечениями, спортом. Неудивительно, что ролики на YouTube и статьи с заголовками, которые начинаются со слов «как сделать…», — в разы популярнее многих других видов контента.
Пошаговые руководства публикуются:
- на информационных сайтах;
- в блогах и на коммерческих площадках;
- на форумах и в социальных сетях.
Правила написания
Статья-инструкция должна быть полезной, наглядной и структурированной. Чтобы руководство не только читали, но и использовали на практике, соблюдайте простые правила:
- Правильно выбирайте ЦА. Ответьте на вопрос: кто будет читать пошаговое руководство? Гайд для новичков — это одно. Инструкция для тех, кто уже разбирается в теме и хочет прокачать скилы, — совсем другое.
Представьте, что вы пишете гайд об эффективном управлении интернет-маркетингом на предприятии. Новичкам нужно подробно рассказать о тех вещах, которые опытным маркетологам кажутся очевидными, — например, чем отличаются CTR и CTA, какие бывают метрики и для чего применяются.
- Досконально разбирайтесь в вопросе. Гайды пишут эксперты или копирайтеры.
Эксперты разбираются в теме и имеют достаточно опыта, чтобы написать полезную статью-инструкцию «из головы», однако может потребоваться корректура готового текста. Копирайтеры для подготовки контента используют авторитетные источники в интернете и делают их глубокий рерайт. К согласованию текста перед размещением можно привлечь профильного специалиста, который проверит гайд на фактическую точность и при необходимости внесет правки.
При выборе темы убедитесь, что она соответствует тематике вашего блога или сайта, а главное — актуальна и интересна ЦА. Запомните формулу: один гайд — один вопрос. Распыляться не стоит, иначе статья получится громоздкой и ее будет неинтересно читать.
- Составляйте план будущего руководства. Основа любой инструкции — хорошо продуманные тезисы.
В первом пункте обозначьте проблему, в последнем — результат ее решения. Между первым и последним пунктами опишите четкие последовательные шаги, которые помогут достигнуть цели.
Универсального плана для написания руководств не существует. Иногда в начало гайда необходимо добавить раздел с расшифровкой терминов, иногда — уделить 1–2 абзаца предыстории. Чтобы инструкция использовалась на практике, логика действий должна быть четкой и понятной.
- Перечитывайте готовый текст несколько раз и убирайте «воду». У человека, который читает гайд, нет времени искать нужную информацию среди «каждому известно» и «актуальность проблемы трудно переоценить».
Пишите кратко и по делу, исключайте ненужные подробности, которые делают инструкцию громоздкой.
Убирайте из инструкции канцеляризмы, штампы и стоп-слова — читатели не дочитывают такие статьи до конца. Проверяйте тексты на «воду» в таких сервисах, как «Адвего», Istio.com и Text.ru. Норма — 55–75%, но она может варьироваться в зависимости от тематики.
- Добавляйте картинки и примеры. Гайд без визуального сопровождения — это не гайд.
Добавляйте в текст скриншоты или фотографии, GIF-анимацию и инфографику с диаграммами, блоками и схемами. Они сокращают объем руководства, структурируют информацию, делают ее нагляднее.
Берите на заметку бесплатные сервисы для создания инфографики: Сanva, Easel.ly, Piktochart, Venngage. И еще несколько ресурсов для создания GIF-анимации: Gifovina, Gifs (создает анимацию из видео на YouTube) и Online-convert.
Алгоритм написания
Для удобства разделим написание статьи-инструкции на четыре шага:
Шаг 1. Подготовка и сбор информации
На этом этапе будет легко интернет-маркетологам, экономистам, юристам, нутрициологам и всем, у кого есть практический опыт, чтобы написать полезную статью и подкрепить советы интересными примерами.
Если вы копирайтер или эксперт, но хотите собрать дополнительную информацию по теме, проштудируйте аналогичные материалы, форумы и профильные сообщества в социальных сетях, экспертные блоги, научно-исследовательские работы. Посмотрите официальную статистику — это отлично дополняет тексты.
Иногда лучше провести собственное исследование и использовать его в качестве источника для руководства. Например, нужно написать инструкцию о том, как создать сайт с нуля. Посмотрите советы экспертов, сделайте сайт самостоятельно с помощью простого конструктора и расскажите о своем опыте в руководстве.
Скрупулезное исследование клиентских обращений поможет улучшить продукт и доработать УТП. Воспользуйтесь Речевой аналитикой Calltouch Predict, чтобы изучить, кто и по каким вопросам звонит в вашу компанию. Сервис определит пол каждого звонящего, присвоит тег, запишет диалог клиента и оператора и переведет его в текст. Вы поймете, чего не хватает вашим клиентам, и на основе их обращений оптимизируете скрипты продаж или даже сам продукт.
Предикт
Анализируй и сегментируй звонки легко и быстро
Текстовая расшифровка звонков и автотегирование
Подробнее
Шаг 2. Структурирование
Любые статьи, и руководства в том числе, состоят из введения, основной части и заключения. Хорошо продуманная структура упрощают восприятие информации и делает чтение более комфортным.
Введение должно состоять из 2–4 предложений. Используйте его, чтобы быстро ввести читателя в контекст и вызвать у него доверие и интерес. Если тема позволяет, поделитесь любопытным фактом или статистикой, если нет — коротко опишите проблему и переходите к ее решению.
Основная часть — пошаговое руководство. Опишите каждый из этапов и поделитесь лайфхаками. Вся информация должна располагаться в логической последовательности. Не забывайте про визуал — используйте графику, тематические иллюстрации и скриншоты.
Заключение — итоги статьи. Сделайте эту часть полезной для читателя. Составьте памятку с краткими выводами, по которым удобно делать то, о чем было подробно рассказано в основной части вашего руководства. Для этого перечислите 5–7 основных тезисов или сделайте выжимку рекомендаций по типу той, которая будет в конце этой статьи.
Заголовок (H1) должен быть коротким, но емким. Вот несколько примеров, которые можно взять на заметку:
- «Краткая/полная/пошаговая инструкция…»;
- «Создайте…с нуля»;
- «Простой/уникальный способ…»;
- «Как сделать/приготовить/создать…»;
- «Быстрое решение…»;
- «8 шагов для…»;
- «Метод…»;
- «Секрет правильного…».
Внутренние подзаголовки (H2, H3…) разделяют информацию на блоки или являются этапами пошаговой инструкции — это зависит от объема текста.
Шаг 3. Написание текста
У вас есть тезисный план и подготовлена информация, поэтому дело за малым — написать текст. Берите поочередно каждый шаг из плана и раскрывайте тему. Не перескакивайте с одного этапа на другой, соблюдайте последовательность. Пишите лаконично и по делу, оставляйте заметки — если не пригодятся, уберете их при вычитке.
Избегайте длинных абзацев. Если они больше 6 строк, разбивайте их на две части — так текст будет легче читать. Придерживайтесь единого стиля, используйте глаголы в побудительном наклонении для имитации диалога — читателям это нравится. Если что-то перечисляете, используйте списки, если что-то сравниваете — таблицы.
Шаг 4. Завершение
Когда инструкция будет готова, вычитайте текст, чтобы убедиться в отсутствии опечаток, ошибок и тавтологии, а затем проведите своеобразный тест-драйв. Пересмотрите все пункты еще раз и убедитесь, что читателям будет понятен каждый шаг, а еще лучше — дайте прочитать статью кому-нибудь из коллег или друзей. Свежий взгляд со стороны помогает исправить недочеты.
Помимо грамотно составленных инструкций, работу маркетологов облегчит и оптимизирует Сквозная аналитика Calltouch. Сервис поможет оценить эффективность маркетинговых кампаний — точно подсчитает данные по количеству переходов на сайт, заключенных сделок и сумме прибыли. Эту информацию система свяжет с соответствующими рекламными каналами, и вы поймете, какие площадки приносят прибыль, а какие — только расходуют бюджет.
Сквозная аналитика
Оценивайте эффективность всех рекламных кампаний в одном окне от клика до ROI
Вкладывайте в ту рекламу, которая приводит клиентов
Подробнее
Вместо вывода
- Если вы хотите написать гайд, но не знаете, какую тему выбрать, проанализируйте статьи конкурентов, соберите популярные поисковые запросы в Wordstat. Подумайте, о чем было бы интересно узнать вашей ЦА.
- Начинайте составлять статью-инструкцию с постановки цели. Определитесь, для кого и для чего предназначено пошаговое руководство. Если хотите, чтобы вашу статью с интересом читали до конца, не перегружайте ее терминологией.
- Если пишете инструкцию для новичков, то не пропускайте шаги, которые кажутся слишком простыми. Пусть лучше читатель сам пропустит очевидный для себя этап, чем не узнает, что это действие было необходимо выполнить для достижения результата.
- Пишите емко, избегайте длинных конструкций и воды. Дополняйте текст инфографикой, скриншотами и тематическими иллюстрациями.
В статье рассказывается:
- Для чего нужна инструкция
- Виды инструкций
- 5 критериев хорошей инструкции
- 6 этапов написания инструкции
- Структура инструкции
- 9 советов по написанию отличной инструкции
- Часто задаваемые вопросы про написание инструкций
- Что делать дальше после публикации инструкции в блоге
Чтобы написать инструкцию, следует выбрать тему, продумать план и структуру, подготовить иллюстрации. Но перед всей этой кропотливой работой вы должны для себя определить – кто в итоге будет читать материал. Для этого придется проанализировать целевую аудиторию и разделить ее представителей на продвинутых и новичков. Для одних будет интересно руководство с использованием профессионального сленга, а другим придется все разжёвывать.
Написанную инструкцию потребуется еще оформить, разбить на главки – шаги, к которым прикрепить фото. Если таковых нет, можно прибегнуть к помощи Ютуба. И после публикации работа не заканчивается. Вам нужно анализировать метрики (сколько человек просмотрели, дочитали и т. д.), общаться с пользователями, отвечать на их вопросы. В общем, предстоит много работы! Но давайте обо все по порядку.
Для чего нужна инструкция
Чтобы любая социальная платформа успешно функционировала и приносила пользователю качественный и регулярный трафик, ему необходимо включить в свой контент интересные материалы. Очень полезны различного рода руководства.
Как же написать качественную инструкцию? Чтобы ответить на этот вопрос, прежде всего надо разобраться с самим определением. Инструкция – это пошаговое руководство, указания и действия, совершаемые в определенном порядке, выполняя которые можно достичь определенной цели. На просторах Интернета можно найти миллионы рекомендаций и ответов по каждому вопросу.
Как написать пошаговую инструкцию – это, скорее всего, вопрос к самому владельцу блога, так все будет зависеть от того, насколько хорошо автор статьи владеет знаниями в той или иной области. Хотя, придерживаясь определенной четкой структуры, практически любой сможет составить развернутое и полезное объяснение в какой-либо теме.
В чем выражается необходимость инструкции? Ответ на вопрос вполне логичен, по крайней мере для читателя, ведь это развернутое объяснение по решению его проблемы, но давайте посмотрим на это со стороны автора. Для самого блогера это один из способов привлечения подписчиков и повышения активности на его страничке, а значит и увеличения потенциальной аудитории. Кроме того, написание инструкции можно рассмотреть с точки зрения копирайтера. Для него это – возможность систематизации и упорядочивания информации, пополнение знаний, ну, и естественно, доход.
Как же надо написать текст инструкции, чтобы он был интересным и просматриваемым? Важно помнить: каким бы профессионалом вы ни были, и как бы ни ориентировались в той или иной теме, ваше руководство прежде всего пишется для простых людей, которые вообще не разбираются в этом направлении (иначе зачем бы им понадобилась инструкция), либо ориентируются в нем очень поверхностно.
Одним словом: то, что планируете писать у себя в блоге, должно быть простым, доступным, информативным, подробным и эффективным. Если инструкция так и не решила проблему читателей, вряд ли вы получите дополнительный поток подписок.
Виды инструкций
В вопросе о видах руководств нет однозначного ответа, как и в том, как правильно написать инструкцию по применению, по эксплуатации, по созданию и т. д. Все дело в том, что одна и та же проблема может быть решена разными способами. Кроме того, манера подачи информации у разных блогеров будет разной. На это влияет не только контент, но и ряд других факторов, например, платформа, на которой эти материалы размещаются, тема, с которой связано руководство, и прочее.
Однако если говорить об инструкциях в целом, можно выделить ряд направлений, которые выделяются из бесконечных классификаций:
-
о строительстве чего-либо или же сборке какого-нибудь предмета мебели, процессора и т. д.;
-
по применению;
-
по принятию лекарственного препарата;
-
лайфхак по типу «Как создать/сделать…»;
-
кулинарный рецепт.
Перечень не весь, но тут обозначены наиболее популярные и распространенные запросы читателей.
К отдельной категории можно отнести «специфическую инструкцию», или узконаправленную. Речь идет про материалы из разряда:
-
пошаговое написание своего романа;
-
инструкция по созданию чего-либо в домашних условия, что по своему назначению к этому не подходит;
-
порядок действий при нестандартных ситуациях; и т. д.
Любой вид инструкции по своему содержанию может относиться либо к описательным, либо к сценарным. Давайте разберем подробнее.
Описательные
Описательная инструкция, как правило, не несет практического характера, скорее, она рекомендательная. Ее задача рассказать, что из себя представляет объект/услуга, о функциональности, достоинствах и недостатках, возможностях и областях применения, о составе и стоимости. Например:
«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».
Сценарные
Если вашим запросом будет, например, «как написать инструкцию по эксплуатации оборудования», то вам откроются пошаговые действия, которые необходимы для решения проблемы, – это и есть сценарный вид инструкций. Например, как установить картридж в принтер, или как запустить ксерокс и т. д.
Еще один образец того, как можно написать сценарную инструкцию:
«Включите стиральную машину с помощью кнопки СТАРТ. Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».
Как раз-таки и сценарные инструкции, кроме пошаговых действий, могут включать в себя различные лайфхаки, более легкие способы применения, горячие клавиши, профессиональные особенности и приемы. Например, в инструкции установки встроенного шкафа-купе в качестве лайфхака может присутствовать совет о том, что между рельсом и потолком из гипсокартона необходимо проложить фанеру, это не даст креплению ослабнуть при длительном использовании.
Для понимания различия: обзор функций нового выпущенного смартфона – описательная, инструкция по поклейке обоев – сценарная.
Кроме того, формат инструкций может быть:
-
текстовым;
-
видео;
-
скринкастингом – запись всех действий с экрана компьютера или смартфона;
-
инфографичным – каждый этап сопровождается фотографиями;
-
голосовым;
-
FAQ – сервис по часто задаваемым вопросам.
Источник: chaylek/ shutterstock.com
Каждый формат нужно подбирать к соответствующей проблеме. Если вы говорите о программном обеспечении или о деятельности, которую необходимо совершать за компьютером, то подойдет скринкастинг. Инфографика уместна для пошаговых действий типа способа приготовления блюда или сборки мебели. Голосовые, текстовые и видеоформаты способны объединить в себе несколько форматов и подходят для большинства товаров. Выбор огромный, главное – решите, что подойдет в вашем случае.
5 критериев хорошей инструкции
Самый эффективный для автора формат руководств – статьи-инструкции. Он не только позволяет продемонстрировать читателям глубокие понимание темы, но и дает прекрасную возможность закрепиться в вашей нише на долгое время. Более того, качественно составленная инструкция присылается знакомым и остается с пользователем на многие годы, а это увеличивает трафик и количество подписчиков.
Как правильно написать инструкцию:
-
Актуальность темы
То, о чем пишете, должно быть представлено аудитории своевременно. Инструкция сработает только в том случае, если получит отклик читателей, а значит, выбранный вами контент должен соответствовать формату.
При публикации постов на «Хабре», например, не стоит писать о темах, ориентированных на новичков. Даже если это то, что актуально, популярностью оно пользоваться не будет. Покопайтесь в больших объемах информации и найдите цепляющее содержание. Специализированные форумы, журналы и статьи вам в помощь.
-
Применение в деле
Если руководство невозможно использовать на практике – это плохая инструкция. Любой читатель захочет проверить, насколько эффективным окажется предлагаемое решение. Текст должен быть конкретен, последователен и прост. Давать общие советы и рекомендации может любой дилетант, но вы – профессионал. Пишите четко, определенно и по делу.
-
Все необходимое
Крайне важным моментом будет наличие в статье всего необходимого, чтобы не пришлось искать дополнительную важную информацию по другим сайтам. Если речь идет об оформлении документов – прикрепите их образцы или хотя бы ссылки на них. Если пишете о достоинствах того или иного товара, укажите, где его приобретали или дайте конкретную ссылку на продукцию. Все это облегчит поиск читателю, а вам добавит доверия.
-
Наглядная демонстрация
Так сложилось, что визуальная информация воспринимается человеком лучше, чем текстовая. Если есть возможность инструкцию сопроводить подходящими фото, изображениями и схемами, непременно добавьте их. Примеры – еще один эффективный инструмент, позволяющий сделать инструкцию понятной и более полезной.
-
Алгоритм и последовательность
Инструкция – это четкий план действий, в котором никак нельзя пропустить какой-то шаг или поменять его местами с другим. Это тот формат постов, где необходимо соблюдать четкую структуру и последовательность. Пробелов, недочетов в таком рецепте быть не должно.
Помните: чтобы написать грамотную пошаговую инструкцию, вы сами напрямую должны были с этим столкнуться и прийти к успешному результату. Экспертное мнение и профессиональный опыт станут лишь дополнительными бонусами. Просто посмотреть инструкцию в Интернете и переписать ее себе – недостаточно. Детали крайне важны.
6 этапов написания инструкции
Отвечая на вопрос, как написать инструкцию, можно выделить шесть основных этапов. Соблюдая их, получится составить полезный и нужный пользователям материал:
-
Поиск проблемы. Любая инструкция несет в себе решение задачи путем совершения определенных действий. Важно, чтобы проблема соответствовала общей тематике сайта или вашего блога.
-
Ориентирование в проблеме. Чтобы инструкция была хорошей, автор сам должен разбираться в вопросе. Это должен быть ваш опыт, а не взятый с просторов Интернета и непроверенный лично перечень действий.
-
План решения. Первым пунктом в этом деле будет обозначение проблемы, последним – результат описанных действий, все остальное – промежуточные шаги, которые позволили из первого пункта прийти к последнему. Главное – этапы должны быть простыми, понятными и информативными.
-
Подробность. Всегда можно что-то добавить на каждом этапе. Избегайте «воды», четко и объемно формулируйте идею каждого пункта.
-
Визуал. Добавляйте в инструкцию инфографику, фото и изображения, которые упростят процесс понимания каждого этапа. Однако имейте в виду, что визуальное сопровождение может быть уместным не везде. Например, в статье «Как правильно написать инструкцию по применению лекарственного препарата», перегруженность фотографиями станет лишней.
-
Советы и рекомендации. Люди доверяют больше опыту и жизненным советам, чем сухому тексту с алгоритмом действий. Используйте это там, где необходимо.
Применив эти правила, получится написать интересную и полезную инструкцию, которая не только сможет решить ряд некоторых вопросов читателей, но и разнообразит ваш контент.
Кейс: VT-metall
Узнай как мы снизили стоимость привлечения заявки в 13 раз для металлообрабатывающей компании в Москве
Узнать как
Структура инструкции
Любая статья требует плана, и инструкция – не исключение. Автору необходимо разбить тему на несколько пунктов и кратко описать каждый, добавить таблицы, цифры и факты, если таковые необходимы.
План выглядит следующим образом:
-
Цель статьи
Тут все достаточно просто. Надо определиться, о чем хотите рассказать подписчикам, какую проблему и как решить. Обозначив цель, вы будете придерживаться той тематики, которую планировали описать изначально, не перескакивая с одного вопроса на другой.
-
Заголовок
Не всегда это бывает просто. Как правило, название материала соответствует самим запросам пользователей, например: «В каком порядке смотреть фильмы Марвел», но если кроме релевантности заголовок еще будет цепляющим, это – гарантированный успех статьи. Очень эффективно срабатывают заголовки, начинающиеся с цифр, и лучше всего использовать не круглые числа типа 10, 20, а нечетные 12, 23, 7 и т. д.
Введение, или лид
-
Вы должны суметь в первом абзаце, а желательно – в первых 2–3 предложениях вовлечь читателя и удержать его. Он должен понимать, что именно эта инструкция – тот самый кладезь информации, который он искал долгое время.
-
Основная часть
В классической инструкции это будет несколько подробно описанных этапов. В статье, освещающей задачу, должны быть разные взгляды на поднятый вопрос. Инструкция-перевертыш – каждый пункт соответствует описанию проблемы, причинам ее возникновения и способу решения.
-
Кульминация и выводы
Резюмируйте все написанное вами, сделайте выводы и побудите своего читателя совершить действия. Если это сделать получилось, считайте, что цель статьи достигнута.
9 советов по написанию отличной инструкции
Чтобы ответить на главный вопрос сегодняшней статьи – как написать инструкцию – важно учитывать следующие особенности ситуации.
Оцените уровень знаний читателя
Прежде чем создавать подробный алгоритм действий, поймите, на кого он будет направлен. Например, вы решили написать о том, как вырастить помидоры в любой почве и в любых условиях.
Смотрим на целевую аудиторию:
-
Это известный фермер, работающий в лаборатории Илона Маска и готовящийся к высадке данной культуры на Марсе?
-
А может – огородник в возрасте, не готовый переплачивать за удобрения и тепличное оснащение?
-
Ученик пятого класса, который делает практическую работу по биологии?
Любому из этих пользователей требуется своя подача материала, которая будет отличаться какими-то особенными моментами, примерами, изображениями, структурой, объемом профессиональных терминов, и др.
Источник: fizkes/ shutterstock.com
Пожилому огороднику не будут понятны научные термины, которые использует фермер-лаборант, а школьнику не нужны огромные объемы помидор, для практической работы ему вполне хватит 1–2.
Если вы не определитесь с тем, для кого вы пишете инструкцию, вы не только потратите зря время, но и понизите востребованность своего профиля. Помните, что новички и уверенные пользователи даже одну и ту же тему воспринимают по-разному.
Проверьте, есть ли уже подобные инструкции
В Интернете есть огромное количество информации по любой теме, потому необходимо узнать, есть ли уже в Сети подобный материал. Если есть: что бы вы могли взять из этой статьи на вооружение? Списывать и адаптировать каждый пункт под себя не надо, просто прочтите ее полностью и почерпните важные моменты, которые, возможно, упустили. Зафиксируйте их в заметках, подумайте, что бы можно к ним добавить еще или убрать.
Готовьте серию инструкций
Как написать пошаговую инструкцию по установке двери, если они могут быть входными, балконными и межкомнатными, различаться по монтажу? Действительно, все не так уж и просто. На самом деле, читателю лучше пригласить специалиста, но если он относится к тем, кто привык делать все самостоятельно, то вам лучше всего написать серию статей с подробным процессом установки каждого вида дверей.
Конечно, можете сделать и общий вариант, указав ряд различий в специализированных монтажах, но вряд ли новичок сможет хорошо ориентироваться в куче информации, представленной в таком виде. Краткое описание действий по каждому типу дверей придется по вкусу как продвинутым домохозяевам, так и новоиспеченным.
Проверяйте инструкции
Безусловно, знания в вопросе будут являются решающим фактором в написании инструкции, но важно не только ориентироваться в теме, но и уметь передавать эту информацию простым обывателям легким и доступным способом. Многие блогеры часто перегружают свои статьи специальными и узконаправленными терминами, пускаясь в бесконечный поток объяснений.
В итоге читатель уже перестает понимать представленную ему информацию. Даже если вы досконально изучили тему, как написать простой и понятный текст в инструкции, и вроде бы знаете все нюансы, обязательно прочтите свою статью еще раз, а в идеале обратитесь к трем людям с разным уровнем знаний в той или иной теме:
-
Редактор. Это тот самый человек, который проверит вашу статью на наличие грамматических и лексических ошибок, избавит текст от ненужных выражений, канцеляризмов и прочих стилистических недочетов.
-
Новичок. Тот, кто подскажет, насколько понятна и проста в исполнении ваша инструкция для человека, который столкнулся с проблемой впервые. При желании он может проверить написанные вами рекомендации на личном примере и поделиться результатом.
-
Эксперт. Настоящий знаток дела сможет подсказать, насколько ваша статья достоверна и при необходимости дополнить ее фактами.
Такой доскональный анализ и редактура инструкции сделают ее читабельной, понятной, популярной и ценной. Будьте уверены, ею будут делиться с друзьями и репостить.
Не переписывайте чужие инструкции
Плагиат – это не выход из ситуации. Публикуя статью, вы можете спокойно ссылаться на других авторов, книги и инструкции, но не копируйте все наглым образом. Во-первых, у создателя его работы могут иметься авторские права, а во-вторых, никому не понравится, если его труды присвоит кто-то другой.
Отжимайте лишнюю «воду»
«Вода» – главный враг хорошего руководства. Она будет лишней в любом тексте, а в инструкции – тем более. Когда человек хочет решить проблему, наличие канцеляризмов и долгих объяснений только раздражает. Нужен краткий и информативный текст, чтение и осознание которого не займет много времени.
Неудачно написанная инструкция начинается примерно так:
У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.
Как правильно написать инструкцию в этом случае:
В данном гайде вы найдете 11 простых способов рисования круга в «Фотошопе». Руководство подойдет для версии СС 2015 и выше.
В этом вступлении нет никакой воды, понятно, о чем будет речь и сколько примеров. Чем короче руководство, тем оно привлекательнее, но не забывайте об информативности предложений.
Без картинок – никуда
Уже не первый раз мы говорим о важности визуального сопровождения. Сплошной текст очень раздражает глаз, его попросту лень читать, но если пункты дополняются соответствующей иллюстрацией, восприятие уже меняется.
Бывает так, что определенную кнопку или горячую клавишу трудно найти, и описание ее местонахождения займет целый абзац. Картинка сделает эту информацию более приемлемой. И автору проще, и читателю понятнее.
Редко, но бывает такое, что соответствующей фотографии нет, тогда вам на помощь приходит YouTube. Там-то есть все. Смо́трите видео, нажимаете на паузу и делаете скриншот. Если у вас есть больше свободного времени и желания, визуальное сопровождение вы можете нарисовать сами в графическом редакторе. Если наличие видео или фото может быть неудобно и неуместно, тогда ставьте анимацию.
Прекрасной альтернативой текстовой инструкции может стать видеоответ, где вы детально все описываете и показываете. Возможно, кто-то захочет читать и смотреть видео одновременно, но не включая звук. В таком случае добавьте субтитры.
В рецептах и тех инструкциях, где особенно важен результат, не забудьте прикрепить фотографию того, что получилось. Читателям важно знать, к чему они придут, если будут следовать вашим указаниям.
Выдерживайте статью в одном стиле
Единый стиль написания – еще один фактор, влияющий на успешность статьи. Информация должна быть представлена цельным полотном, не перегружена канцеляризмами, речевыми оборотами и сложными предложениями. Наличие фактов и изображений, отсылок на мнения известных людей станет хорошим инструментом воздействия на читателей.
Пример неверного написания:
Цвет в интерфейсе сразу обращает на себя внимание и несет определенную смысловую нагрузку, его следует использовать осторожно и со смыслом.
Образец, как надо написать инструкцию, чтобы она была читабельной:
Цвет — это инструмент управления вниманием пользователя: он помогает выделять главное. В интерфейсе краски используются для передачи смысла, а не для оформления.
Источник: Mila Supinskaya Glashchenko/ shutterstock.com
Общие советы, которые вроде бы и говорят о важном, но в то же время не дают никакой конкретики, тоже не принесут результата.
Неправильно (т. к. нет никакого четкого пояснения):
В интерфейсах должна быть простая и понятная навигация.
Старайтесь избегать местоимения «мы», по возможности.
Запреты тоже могут быть нескольких типов. Используйте каждый там, где это необходимо:
-
Самый мягкий вариант – «Не рекомендуется делать подобным образом».
-
Средний вариант – «Так поступать нельзя».
-
Категоричный и жесткий вариант – «Строго запрещено делать подобное».
Не забывайте «оживлять» инструкцию, объясняя, почему так делать не рекомендуется или, наоборот, делать сто́ит, приводите примеры, факты и делитесь опытом из вашей жизни.
Не забывайте о безопасности
Важным моментом в написании инструкции является безопасность. Инструкции, которые вы пишете, могут быть связаны с любой темой, и порой не самой безопасной, поэтому не забывайте ставить пояснение о мерах предосторожности, будь то консультация со специалистом или использование средств защиты.
Скачайте полезный документ по теме:
Чек-лист: Как добиваться своих целей в переговорах с клиентами
Часто задаваемые вопросы про написание инструкций
-
Каким категориям бизнеса рекомендуется использовать инструкции?
В принципе, любой бизнес-сфере не помешают статьи с инструкциями относительно того продукта/услуги, которую выпускает организация. Магазины могут писать о руководстве по использованию своего товара и его эксплуатации, различные финансовые организации могут представить гайд о том, как регистрироваться на каких-либо экономических площадках, туристические фирмы могут сделать материал о том, какую страну и как лучше выбрать для проведения новогодних праздников, и т. д.
Делясь информацией с широкой публикой, фирма повышает процент доверия себе и получает больше шансов заполучить потенциального клиента.
-
Чем инструкция отличается от обзора?
В наше время при частом смешении жанров эта граница стирается. Однако, если говорить официальным языком: обзор – демонстрация продукта, инструкция – представление действия, благодаря которым можно выбрать среди множества товаров тот продукт, который будет соответствовать всем требованиям потребителя.
Заголовки статей типа: «Как выбрать автомобиль…» больше подойдут под жанр инструкции, так как будут содержать в себе подробный алгоритм действий, по которым можно выбрать то, что потенциальному покупателю нужно.
-
Как узнать, для какой аудитории пишется инструкция?
Как написать правильную пошаговую инструкцию, которая понравится потребителю? Все просто – пообщайся с клиентом.
Решая проблему потенциальных покупателей, вы сможете понять, что именно им нужно и как это преподносить. Узнаете, насколько люди осведомлены, каким уровнем знаний по этой теме обладают. Ответив на ряд таких вопросов, вы уже сможете подобрать стиль написания статьи. Обратившись к менеджерам по продажам или к операторам горячей линии, узнаете, с какими трудностями обычно сталкиваются эти потребители.
-
Какой объем инструкции считается оптимальным?
По большому счету, это зависит от автора и самой темы инструкции, но, как показывает практика, чем короче руководство, тем лучше. Есть возможность уместить объяснение в одно-два предложения? Прекрасно! Читатели оценят.
Что делать дальше после публикации инструкции в блоге
Как написать инструкцию, мы разобрали, но что же делать, когда текст готов, проверен редактором, логичен, информативен и даже уже поставлен в пост? Для развития контента и увеличения трафика необходимо соблюдать следующее:
-
Регулярность выхода
Обновление контента важно не только вашим постоянным читателям, но и случайным пользователям. Однако это не значит, что предыдущие статьи должны быть забыты. Наоборот, они нуждаются в регулярных обновлениях и повторных публикациях. С точки зрения продвижения, в корректировке старых постов больше выгоды, так как их индексация занимает у поисковых роботов меньше времени.
-
Email-рассылки
Важным шагом после того, как удалось написать пошаговую инструкцию, будет электронная рассылка. Когда читатели изучили ваше руководство, переместите их на страничку с формой согласия на получение новостей. Таким образом пользователи будут уведомлены об обновлениях либо смогут получать информацию напрямую.
-
Взаимодействие с читателями
Контактируйте с вашей аудиторией. Побуждайте потенциальных клиентов писать пояснения и делиться мнениями, ведь это повысит популярность странички и увеличит движение трафика. Комментарии – это прекрасный инструмент, способный оказать существенное влияние на продвижение вашего аккаунта. Кроме того, пользователи смогут там делиться и другими полезными инструкциями, лайфхаками и ссылками.
-
Возможность оценки контента
Поставьте кнопки оценки вашего контента. Это могут быть лайки/дизлайки, эмодзи, добавление в избранное. По утверждениям психологов, возможность сообщать свое мнение и говорить о том, полезен ли контент, дает людям ощущение нужности, а это благоприятно воздействует на их душевное состояние.
-
Возможность делиться инструкциями
Желание представить статью другим не только позволяет пользователям передавать полезную информацию, но и делает ваш блог популярным.
-
Сотрудничество с другими авторами
Сторонние площадки, подходящие вашей тематике, могут стать прекрасным полем развития блога. Общайтесь с другими авторами, работайте по бартеру – таким образом, вы сможете помочь друг другу повысить трафик, улучшить контент и увеличить популярность среди подписчиков.
-
Анализ инструкций
Анализ контента – важный фактор в успешном продвижении блога, в котором публикуются инструкции, лайфхаки и обзоры. Есть масса инструментов, способных в этом посодействовать, например, Яндекс.Метрика – раздел «Контент».
Там можете увидеть количество просмотров вашей инструкции, сколько времени на странице провели пользователи, сколько посетителей, прочитав один пост, перешли к другому, и т. д.
-
Подгрузка видео из YouTube
Благодаря блогу вы можете развить Youtube-канал. Снимайте подробную инструкцию, публикуйте ее на Youtube, а затем делитесь ссылкой в своем аккаунте. Пользователи, переходя по ссылке, скорее всего, подпишутся и будут изучать это видео уже напрямую, тем самым увеличивая просмотры.
-
Наличие подкастов или голосовой записи инструкций
Различные подкасты и голосовые записи могут стать удобной альтернативой изучения руководства, если ваш читатель, например, едет за рулем автомобиля или занимается в спортзале и у него нет возможности смотреть видео или читать.
Материалы, в которых описаны качественные и грамотные инструкции, определенно будет иметь успех, а при умелом оформлении, когда есть возможность оценки контента и поделиться публикацией, количество читателей станет расти. Если будете следовать всем рекомендациям из этой статьи, созданная инструкция не только позволит увеличить трафик, но и расширит вашу аудиторию.
Статья опубликована: 01.03.2022
Облако тегов
Понравилась статья? Поделитесь:
Туториал для туториалов. Как написать пользовательскую документацию
Время на прочтение12 мин
Количество просмотров27K
Есть устоявшеёся мнение, что для хороших продуктов руководство пользователя не нужно. Очередной холивар на эту тему разгорелся в нашем рабочем чате. Я не до конца согласен с этим утверждением.
Хороший интерфейс действительно должен помогать пользователю быстро понять продукт и научиться им пользоваться. Как всегда есть пара НО.
-
Пользователи бывают разные. То есть они могут отличаться как по возрасту, отрасли и опыту, так и по количеству мотивации. Мотивация особенно касается b2b сервисов. Многие пользователи попадают в продукты, потому что «Начальник сказал».
-
Продукты бывают сложные. Быстро разобраться и понять все их фишки без документации сложно или невозможно.
Документация помогает пользователю решить проблему или помочь разобраться с особенностями и фишками продукта. В любой документации люблю раздел Tips&Tricks.
Что входит в пользовательскую документацию
Пользовательская документация — это не юридические документы. У них другие цели.
Пользовательская документация — это материалы, которые помогают пользователю использовать продукт на максималках.
Что еще можно отнести к пользовательской документации
Документация для разработчиков и администрированию: доки по API, инструкции по установке и администрированию. Но сейчас их касаться не буду.
В пользовательскую документацию я включаю:
-
Ответы на часто задаваемые вопросы (FAQ).
-
Руководство пользователя. Это самый жирный кусок из всей пользовательской документации. Здесь описывается весь интерфейс, только текстом.
-
Краткое руководство пользователя. Короткая презентация или документ для быстрого начала. Описывает базовые функции, возможности и советы для начала. Главное отличие от полного руководства — быстрее читаются, дают базовое представление о продукте и особенно помогают при внедрении b2b продуктов.
-
Описание отдельных фишек (Tips&Tricks). Чаще всего их делают в формате видеоуроков, но можно наткнуться и на текстовые.
-
Релизноуты. Считаю их важной частью пользовательской документации. И, говоря релизноуты, я имею ввиду не разовые, которые выкладываются в магазины приложений или к себе на сайт. А написанные раз в какой-то период. Можно раз в месяц. При работе над прошлым продуктом мы писали всё, что исправили или добавили за месяц. Хорошим тоном, на мой взгляд, будет писать самое важное.
-
Видеоуроки. Считаю их частью пользовательской документации, но это скорее вкусовщина, чем правило.
Почему это важно?
Хорошо написанная пользовательская документация помогает разгрузить поддержку. Особенно если первый контакт у вас происходит через бота. Боты берут ответы на типовые вопросы из документации. А если большая часть ваших запросов типовые, несложно подсчитать насколько это разгружает поддержку.
Если в вашей поддержке сидят операторы, то документация поможет им найти ответ на вопрос, если они не знают и быстро скопировать нужный текст для отправки. Или вообще отправить ссылку на кусок документации, который решает проблему пользователя.
Документация помогает пользователям разобраться в продукте или узнать какие-то неявные фишки. Я, например, часто ползаю в гайды разных продуктов, чтобы посмотреть как какую-то штуку сделать и можно ли её вообще сделать.
Документация помогает вам работать с корпоративными заказчиками, но об этом дальше.
Красоты B2B рынка
Прошлый продукт, над которым мы с командой работали, умел и в облако, и в on-premise.
С облаком все понятно. Динамическая документация на сайте или в другом сервисе. Документация для корпоративных заказчиков имеет определенные особенности.
Особенность #1: Корпорации любят печатную документацию. Очень сильно.
Мой знакомый сейлз любит рассказывать истории про это.
Резюме его историй:
Если вдруг что, отчитываться о покупке, установке и эксплуатации корпорации будут большими стопками документации.
Поэтому чем толще кипа бумаги — тем лучше.
Особенность #2: Нужно отдавать дополнительные пакеты документов.
В дополнительные пакеты документов входит: документация по установке вашего ПО и документацию по его администрированию, а может ещё что-то, если попросят.
Особенность #3: Документацию, которую вы отдаете корпоративному заказчику, нужно будет поддерживать отдельно.
Реальность работы с большими корпоративными заказчиками в том, что ваш продукт требует доработки для решения их задач. Всегда есть какие-то нюансы и дополнения. Поэтому отдавать им облачную документацию, чаще всего, не получится.
Особенность #4: Встречается реже, но тоже требует внимания. Если ваш продукт визуально кастомизируется (меняются цвета, меняется расположение кнопок), то для каждого заказчика с нестандартным интерфейсом нужно будет делать свою документацию. Это не правило, а скорее хороший тон и забота.
Где делать?
Много думал, долго смотрел. Переделывал наш гайд раз пять.
Когда искал, ставил для себя следующие задачи:
-
Документацию можно сделать динамической. То есть возможность грузить видео, гифки, делать кросс-ссылки.
-
Поддерживается базовое форматирование: заголовки, жирный, курсив, code, code block.
-
Возможность экспортировать в .pdf.
Небольшой совет
Касается не только пользовательской документации, а вообще любой документации. Если это документ не на согласование, а уже передается, отдавайте всегда в .pdf. Вы избежите много проблем, а самое главное, он будет выглядеть так, как вы задумали и ничего не поедет.
-
Есть возможность выложить документацию на свой домен.
-
Есть возможность кастомизации для заказчиков. Поменять цвета, добавить логотипы и прочее.
Какие вариант рассматривал:
-
Самописные.
Стоимость: может быть любой и измеряться в человеко-часах.
Плюсы: можно накрутить и наворотить, что по кайфу.
Минусы: долго, дорого, больно, потому что полноценный отдельный продукт, но для компаний больше 100 человек, может быть хорошим решением. -
Google Docs.
Стоимость: Free
Плюсы: очень удобно работать с вёрсткой документа; привычный, при этом более простой интерфейс, относительно MS Docs; есть синхронизация с облаком; есть экспорт в .pdf.
Минусы: очень тяжело работать с визуальной частью — скринами; отношу в категорию не динамичных, так как выложить ссылочку на сайт на Google Doc конечно можно, особенно учитывая их последние апдейты, но это выглядит как-то не серьезно. -
Notion.
Стоимость: можно Free, если работает один человек, а так от 8-10$ за человека.
Плюсы: очень удобно делать динамическую документацию, которую не стыдно выложить на сайт, по моим ощущениям; удобно работать в паре, есть все необходимое; можно вставить любое медиа, хоть ссылку, хоть видео, хоть схему из miro.
Минусы: не самый широкий спектр инструментов для работы с версткой; если неправильно сверстать, скопировать кусочек текста в другое место бывает накладно; не для всех пользователей привычная навигация по страницам. -
Другие инструменты для wiki. Я смотрел на несколько вариантов wiki.js, Stonly 2, Dropbox Paper, Outline.
Смотрел давно, поэтому ничего вразумительно сказать не смогу. Помню, только что из всего выше, зацепил Dropbox и Wiki.js. В процессе написания этой статьи наткнулся ещё на один интересный сервис — GitBook. Он удовлетворяет всем моим запросам к подобным инструментам, но прошел мимо меня когда выбирал.
-
Figma.
Не пробовал, но хочу попробовать для ускорения работы именно с корпоративной документацией, есть у меня одна идея, как будет время попробую и расскажу.
С чего начать?
Не скажу ничего нового.
Начинать нужно с ответа на вопрос «Зачем мы это будем делать?». Мы начинали писать первую версию как раз для корпоративного заказчика. Но эта итерация была небольшой. Писали краткий гайд.
Потом я понял, что мне уже тяжко писать в поддержке одно и то же. Полный гайд сел писать, когда хотел немного разгрузить именно поддержку.
После того, как поняли зачем, накидайте план, а точнеё оглавление. План подразумевает последовательность, а оглавление позволяет вам писать не последовательно. Я писал непоследовательно. Сначала писал то, что помнил на память, потом все остальное.
Написали итерацию, дайте ей отлежаться немного. Вторым заходом я всегда добавлял медиа и проверял текст на логику, ошибки и соответствие реальности. Медиа делал второй итерацией, чтобы не отвлекаться от текста, так проще структурировать работу.
Я постарался написать о самых важных вещах, с которым я столкнулся, начав работу над этой задачей. Теперь хочу удариться в детали и рассказать о важных нюансах.
Основные правила
Понятный и простой язык
Я не буду писать о важности соблюдения правил русского языка: орфографии, пунктуации. И не буду рассказывать «Как писать хорошо?». Я сам далеко не эксперт в этом вопросе, поэтому когда мне нужно написать хороший текст я всегда обращаюсь к заветам Ильяхова и сервисам Главред, Яндекс.Спеллер и LanguageTools.
Любой текст должен быть простым и понятным.
Самое главное всегда это помнить.
Из рекомендаций, которые могу дать я лично — отказываться от привычных определений и писать ещё проще.
Например, вместо «Кликнуть» писать «Нажмите», вместо «Свайпнуть» — «Провести». Так нужно делать, потому что среди пользователей могут быть люди, которые не знают даже базовых терминов.
Понятное и аккуратное форматирование
Я люблю типографику и когда все аккуратно. Поэтому случаются приступы гнева, когда документы плохо сверстаны. Считаю это важным, так как эти правила придумали не просто так, а чтобы было удобно для читателя.
Правил много. Расскажу про самые бесячие и самые важные, на мой взгляд:
-
Кавычки.
Все то ли ленятся, то ли не знают где на клавиатуре находятся наши кавычки. У меня есть предположение, что эта привычка пошла со школ, потому что руками мы пишем другие кавычки.Основные кавычки оформляются елочкой «», внутренние кавычки оформляются лапками „“. Например, «Нажмите на вкладку „Контакты“ в левом верхнем углу», забугорные кавычки выглядят так «_».
Рекомендации по оформлению текста от Риановости P.S. Иностранные названия в русском тексте кавычками не выделяются.
-
Тире и дефис.
Все знают про тире и дефис. Оказалось, что многие не знают про среднее тире.Дефис (-) используется для присоединения частиц (что-то), для присоединения префиксов (по-братски), в словосочетаниях и сложносоставных словах (бизнес-ланч).
Среднее тире (–) применяется в числовом обозначении диапазонов и интервалов: 2011–2022, 11–12 ноября.
Длинное тире (—) используется для выделения прямой речи, указания маршрутов (Москва — Санкт-Петербург), между подлежащим и сказуемым.
-
Оформление списков.
Существуют два вида списков: нумерованный и маркированный.Маркированные списки выделятся буллитами, длинным тире или выключкой (реже всего встречается, сдвиг вправо, без символа), нумерованные списки выделяются числами.
Традиционный символ маркированного списка в русской типографике — тире, а не буллит. Говорят, что буллиты пришли к нам в месте с софтом от Microsoft. Мне нравятся буллиты и я чаще пользуюсь ими. Но они яркие и привлекают внимание. С одной стороны, это хорошо, с другой — с ними стоит быть осторожней. Если буллитов много, они могут перетянуть на себя внимание читателя.
Нумерованный список используется когда есть четкая последовательность пунктов. Когда последовательности нет — всегда маркированный.
Ещё один важный момент.
-
Если пункт списка начинается с большой буквы, на конце всегда точка.
-
Если пункт списка один или два слова и начинается с маленькой буквы, на конце запятая, в конце списка точка.
-
Если пункт списка длинный и внутри пункта есть запятые, на конце ставим точку с запятой.
-
-
Оформление дат и чисел.
Если в тексте присутствуют даты, то лучше писать 15 мая 2021, а не 15.05.2021. Помогите пользователю думать только о важном.Если есть числа, то их нужно тоже оформить правильно. Не 2221, а 2 221. Отделяйте тысячные, это очень сильно упрощает восприятие.
-
Вы или вы.
Мое стойкое мнение — если это не коммуникация с кем-то из государственной организации в переписке, всегда писать вы и ваш с маленькой буквы. Иначе выглядит, что вы кричите на пользователя, а на пользователя нельзя кричать.В случае с гос. организациями все очень просто, я считаю, что если они узнают, что можно писать с маленькой, их мир рухнет.
-
Буква Ё.
С этой буквой у меня особые отношения. Исторически моя фамилия пишется через Ё, но из-за передергивания правил русского языка в советском союзе моя фамилия теперь пишется через Е. Поэтому я долгое время принципиально везде писал Е. Годы идут. Мозгов прибавилось. Теперь стараюсь писать Ё везде, где ей место. Так действительно проще воспринимать текст. -
Эмодзи в тексте ?
По этому поводу много споров как у нас в команде, так и в кругах пишущих. Я придерживаюсь мнения, что эмодзи в тексте допустимы, но очень дозировано.Я использовал эмодзи для визуального подчеркивания каких-то кнопок в интерфейсе.
Например: Нажмите на символ ⚙️ в правом верхнем углу.Для поиска символов пользуюсь Glyphy.
Ещё есть классный сервис Типограф, он поможет поставить нормальные кавычки, убрать лишние пробелы, в нужных местах заменить дефисы на тире и поправить другую экранную типографику.
Если ваш продукт международный
Правила выше применяются к русскому языку. Если ваш продукт международный, то нужно оформлять по международным правила. В некоторых местах правила могут сильно отличаться от наших стандартов.
Удобная навигация
Нет единого мнения — как правильно. Если самопис, я рекомендую делать вертикальную навигацию слева. Такая часто встречается в технических документациях.
По структуре, на мой взгляд, можно выделить такие блоки:
-
Блок общего и важного.
-
Описание вашего решения. Вдруг пользователь попал сначала на ваш гайд, а не на сайт.
-
FAQ.
-
Какие есть приложения, со ссылками на скачивания или как пользоваться, если это например веб-версия.
-
Наши обновления.
-
-
Блок «Как начать». Сюда писать общие вещи, которые касаются всего сервиса. Особенно важный блок, если у вас мультиплатформенное решение.
-
Блок с руководством пользователя. Если у вас мультиплатформенное решение, то на каждую платформу лучше писать свое руководство. Можно объединять мобильные приложения и ПК версию. Так можно делать если нет глобальной разницы.
У нас, например, исторически разницы не было. Поэтому iOS и Android лежат на странице «Мобильные приложения». Но сейчас мы начали разделять, поэтому в будущем будет разделение на ОС.
Связность
Продукт — это всегда комплекс фич. И они часто между собой связаны. Если в одном месте упоминается другая фича, давайте ссылку на страницу или пункт.
Если хочется сделать по красоте, то можно внимательно изучить методологию Zettelkasten, например.
Удобный поиск
Тут много писать не буду. Если пользователь попал в документацию с конкретным запросом, у него должна быть возможность быстро найти то, что ему надо. Пользователь — не Индиана Джонс и охотиться за минотавром в вашей навигации не планирует.
Вот как мы это в Notion решили.
Логичность
Всё, что вы пишите должно быть логичным.
Порядок элементов в тексте и интерфейсе должен быть одинаковым. Пользователь ломается, когда написано: «Нажмите на вторую вкладку „Контакты“», а вторая вкладка — «Чаты».
Или когда в интерфейсе элемент называется «Назначить админом», а написано «Назначить администратором».
Понятная визуалка
Этот пункт я бы хотел разбить на два блока: работа с медиа и работа с Step-by-Step.
Работа с медиа
Я сторонник динамичных гайдов. Когда есть .gif или видео презентация. Это помогает увидеть наглядно. Если есть возможность, наполняйте вашу документацию .gif.
С видео все сложнее. Оно требует дополнительного действия от пользователя — включить, плюс весит больше чем .gif. Поэтому видео использую редко. Чаще для каких-то больших блоков или полноценных видеоуроков.
Иногда нет возможности сделать документацию динамической, особенно если вы работаете с корпоративными клиентами. Тогда делайте скриншоты реального интерфейса. Для этого лучше завести демо-стенд с близким к реальности наполнением. И там делать скриншоты.
Можно нарисовать демо-стенд в Figma и из этого собирать медиа для гайда. У меня такой подход не прижился, сложнеё управляться.
На скриншотах обязательно нужно выделять шаги, которые описаны в ваших Step-by-Step. Все выделения делать одним и тем же цветом, за исключением ситуаций когда явно нужно разделение.
Очень не люблю стрелочки. Считаю, что лучше выделить место геометрической фигурой и поставить номер шага. Но иногда стрелочки приемлемы, тут вкусовщина.
Из хороших приемов — блюрить лишнюю часть интерфейса или делать выделение лупой важной части.
Для работы со скриншотами я использую стандартный маковский редактор картинок, иногда Figma.
Step-by-step
Step-by-Step — это пошаговое описание всех действий, которые нужно выполнить пользователю, чтобы получить результат.
Искал хоть какую-то информацию про то, как пишутся такие штуки и ничего хорошего не нашел. Поэтому основываясь на здравом смысле, вывел для себя ряд правил:
-
Делать нумерованные списки. Если есть подпункты, то нумеровать их соответственно и делать сдвиг вправо 1.1, 1.2, 1.2.1 и тд.
-
Писать сначала «Что нажать», потом «Где нажать». Исхожу из простой логики — сначала нужно понять «Что искать» и только потом «Где искать».
Например: «Нажмите на кнопку „Включить“ в правом верхнем углу», а не «В правом верхнем углу нажмите на кнопку „Включить“».
-
Вставлять визуальные элементы для кнопок, особенно если они без подписи. Для этой истории приходится немного костылить, если делать это в том же Notion, но в Google Docs это делать проще. Использую стандартные эмодзи и сервис Glyphy.
Например: Нажмите на символ ⚙️ в правом верхнем углу.
Не люблю слово иконка, поэтому пишу символ, чтобы была однозначность. Тоже вкусовщина.
-
Если одно действие можно сделать из разных мест, описывать все места и каждое по пунктам.
-
Если два действия отличаются между собой одним пунктом и кажется бредом писать их два раза, перекреститься и написать два раза. Например, удаление и редактирование часто похожи.
-
Все названия кнопок, сущностей, элементов — должны иметь такое же название как в интерфейсе.
-
Все названия кнопок, вкладок и элементов интерфейса всегда выделяю кавычками. Для того, чтобы выделить и, потому что в какой-то степени это имя собственное.
Поддержка и послесловие
Поддерживать эту историю важно и нужно. В какой-то момент пользователи привыкнут ей пользоваться. Не сами. Вам тоже нужно приложить усилие для того, чтобы люди читали вашу документацию.
Пользователи будут рассчитывать, что найдут там ответ на свой вопрос. Поэтому там всегда должна быть актуальная информация.
Описывать фичу нужно до релиза и вместе с релизом добавлять в гайд. Почему нужно описывать до релиза, думаю, объяснять не нужно.
Раз в 3-6 месяцев заходить и перечитывать, лучше если это каждый раз будет делать новый человек. Это нужно делать по трем причинам:
1. Когда пишешь большие текстовые документы, глаз замыливается. Можно написать бред и после его не заметить.
2. Всегда найдутся ошибки. Даже в книгах, которые вычитывают и проверяют специально обученные люди, есть ошибки. Старайтесь на всех страницах оставлять кнопочку обратной связи, чтобы пользователи могли помочь с поиском ошибок.
3. Всегда есть что улучшить. Текст это такой же продукт.
Хочется верить, что эта статья сэкономит кому-то время, а кому-то поможет стать немного лучше.
Я не претендую на истину в последней инстанции. Описал свой опыт и мнение.
p.s. Пользовательская документация с которой все началось. Скажу сразу, там очень много чего можно и нужно улучшить. Бэклог по апдейту документации уже перевалил за 30 задач. Постепенно обновляем.
p.s.s. буду благодарен за конструктивный фидбек в комментариях и ещё больше, если поделитесь вашим опытом.