Мануал на товар это - Большая энциклопедия инструкций и руководств

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

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

Виды инструкций

По содержанию инструкции бывают:

Описательные. Цель описательной инструкции – познакомить покупателя с товаром: рассказать о полезных функциях смартфона, возможностях сервиса, материалах оконного профиля или применении битумной мастики.

Пример:

«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».

Сценарные. Сценарная инструкция – это пошаговое руководство для решения конкретной задачи. Например, как заменить струны на гитаре, запустить автотаймер регистратора или сварить пельмени.

Пример:

«Включите стиральную машину с помощью кнопки СТАРТ.

Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

Материалы сборки велосипеда – описательная инструкция, а порядок замены пробитой шины – сценарная.

Еще инструкции разделяются по формату:

текстовые;
видеоинструкции;
скринкастинг – запись действий с экрана компьютера;
инфографика – подборка иллюстраций для быстрой передачи сути;
FAQ – справочный раздел сайта для ответов на популярные вопросы.

Выбор формата зависит от продукта. Например, видео и скринкастинг хорошо расскажут о программном обеспечении. Инфографика наглядно продемонстрирует процесс сборки/разборки мебели. Текстовые (печатные и электронные) подходят для большинства физических товаров и объединяют несколько форматов в один документ.

Продвинем ваш бизнес

В Google и «Яндексе», соцсетях, рассылках, на видеоплатформах, у блогеров

Подробнее

Правила составления текстовых инструкций

Первым делом определитесь с покупателем товара и обстоятельствами, при которых инструкцию будут читать. Например, инструкцию для автомобильной фары читают в гараже или СТО. Поэтому разделите ее на два документа. В одном – расскажите о характеристиках, производителе, особенностях. В другом – покажите схему подключения. Желательно распечатать руководство на плотной бумаге, которая не порвется от многократного использования.

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

Кроме того, важен опыт покупателя. Например, профессиональным мебельщикам не интересен порядок установки фасадов – они и так это знают. Домохозяйкам и новичкам стоит объяснять все «на пальцах».

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

Структура

Типовая инструкция включает следующие разделы:

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

Составьте оглавление, если в инструкции более 5 листов. Это позволит читателю быстро перейти к нужному разделу и не искать информацию в интернете.

Спасибо!

Ваша заявка принята.
Мы свяжемся с вами в ближайшее время.

122 статьи по контент-маркетингу: императорская подборка полезностей

Оформление текста

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

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

Примеры:

Плохо	Хорошо
Для этого необходимо перейти в режим записи видео.	Перейдите в режим записи видео.
Ламинированное покрытие нужно протирать обычными моющими средствами.	Протирайте ламинированное покрытие обычными моющими средствами.
Все детали фурнитуры для получения легкого хода должны смазываться не реже 1 раза в год машинным маслом.	Смазывайте фурнитуру не реже 1 раза в год машинным маслом для получения легкого хода.

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

Примеры:

Плохо	Хорошо
Эта надпись говорит о вероятной поломке механизма.	Эта надпись говорит о поломке механизма.
Сбор данных скорее всего займет 10 минут.	Сбор данных займет 10 минут.

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

Примеры:

Плохо

Хорошо

Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Затем выберите в меню режим «Блок».

Удерживайте кнопку «Пуск» до появления желтой индикации на экране.
Выберите в меню режим «Блок».

Для регулировки створки вам потребуется шестигранник, шлицевая отвертка и монтажный клин.

Для регулировки створки вам понадобятся:

шестигранник;
шлицевая отвертка;
монтажный клин.

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

Примеры:

Плохо	Хорошо
Закрепите радиатор на стене. От правого края батареи отмерьте 10 см для установки воздуховода.	Закрепите радиатор на стене. От правого края радиатора отмерьте 10 см для установки воздуховода.

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

Плохо	Хорошо
Номинальная мощность микроволновки – 700 Вт.	Номинальная мощность микроволновой печи – 700 Вт.
Граната автомобиля передает крутящий момент на ось колеса.	Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса.

Подберите читаемый шрифт текста. Шрифты с засечками (Times New Roman, Georgia) имеют небольшие черточки по краям линий. Они подходят для объемных печатных документов в 12 размере. Шрифты без засечек (Arial, Verdana) хорошо читаются на электронных документах.

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

Примеры шрифтов:

С засечками	Без засечек
Допустимое напряжение в сети от 215 до 230 Вольт.	Допустимое напряжение в сети от 215 до 230 Вольт.

Иллюстрации

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

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

Как я стала писать для «Текстерры»: история бывшего копирайтера

Как написать хорошую инструкцию: 5 шагов, полезные советы, пример

Содержание статьи:

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

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

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

Для чего нужна любая инструкция

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

С точки зрения читателя — это решение его проблемы, в том или ином вопросе, в зависимости от тематики сайта, на котором она опубликована;
С точки зрения заказчика (владельца сайта) — привлечения целевого трафика, а как следствие потенциальных клиентов;
С точки зрения копирайтера — написание качественного текста, который принесет доход или упорядочит информацию в голове.

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

Какие бывают инструкции

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

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

Инструкция по строительству или сборке чего-либо;
Инструкция по применению чего-либо;
Медицинская инструкция;
Инструкция из разряда «Как сделать…»;
Инструкция по приготовлению пиши (рецепт);

Естественно, это далеко не весь перечень, даже самых распространенных видов инструкций, но наиболее известный — это точно.

Существует отдельный вид инструкций, я его называю «специфический», к нему можно отнести:

Пошаговую инструкцию как написать книгу;
Инструкцию как в домашних условиях сделать что-то для этого не предназначенное;
Инструкция как вести себя в той или иной ситуации.

Как написать пошаговую инструкцию (самое интересное)

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

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

Найдите проблему — это очень важный этап. Кроме того, проблема, которую решит ваша инструкция должна полностью соответствовать тематике вашего сайта или сайта заказчика;
Разобраться в вопросе — полностью, досконально и глубоко разобраться в вопросе, о котором будете писать инструкцию;
Разбить решение проблемы на шаги — составе план, в котором первым пунктом будет наличие проблемы, а последним описание результата ее решения. Промежуточными же пунктами должны стать, последовательные, четкие, полные и грамотные шаги по достижению цели;
Распишите более подробно каждый шаг — даже уже написав текст в него всегда есть что добавить. Пусть последовательность решения проблему будет максимально подробной;
Схемы, картинки, примеры — добавьте в статью максимально доступную визуальную информацию. Ее должно быть немного, но в тоже время и не мало. Но помните, что не для всех инструкций такой ход необходим, как, скажем, в этой;
Полезные советы — добавите вставки в текст с полезными советами (также не для всех видов инструкций);

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

Вы пришли сюда из поиска? Это доказывает вышесказанное.

Как написать инструкцию: пример

Как я уже говорил выше, пример написания инструкции — это вся эта статья. Более того, большинство статей на этом сайте, которые начинаются со слова «Как» — являются инструкциями, в той или иной степени.

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

Источник статьи: http://yourwriter.ru/articles/general-articles/how-to-write-a-good-instruction/

Как написать руководство пользователя: подробная инструкция

Поделитесь статьей, пожалуйста:

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

Исследуйте тему

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

Чтобы инструкция получилась полезной копирайтеру нужно разбираться в отрасли на 100%, но описывать её с позиции новичка. То есть ставить себя на место читателя. Прочитайте аналогичные статьи на похожие товары. Это поможет вам лучше разобраться в структуре и стиле такого контента.

Разработайте план и напишите текст

После тщательного изучения материала можно приступать к планированию. Продумайте, с чего лучше начать и чем продолжить. На примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner» я расскажу о принципах написания такого текста.

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

Содержание руководства пользователя на примере инструкции к пылесосу

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

Описание продукта на примере инструкции к пылесосу «Xiaomi mi robot vacuum cleaner»

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

Не используйте в работе личное мнение или собственный опыт пользования товаром. Инструкция — это документ, в котором структурно и чётко описаны шаги и действия.

Добавляйте в статью скриншоты. Наглядно понять работу программы или техники намного проще.

Добавляем скриншоты для наглядности (пример)

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

Уникальное предложение — -50% на ВСЕ курсы Skillbox. Получите современную онлайн-профессию, раскройте свой потенциал.

Пишите текст короткими предложениями с глаголами повелительного наклонения: «Включите компьютер», «Нажмите на кнопку…», «Включите в розетку…».

Пример написания текса для руководства пользователя к товару

Придерживайтесь логики и будьте последовательны. Например, при описании программного обеспечения для ПК: «Включите компьютер. Вставьте диск в дисковод…». Будет нелогично писать: «Начните работу с диском, затем включите ПК». Завершайте инструкцию ответами на частые вопросы и/или описанием неисправностей и как их устранить.

Рекомендации и советы по написанию руководства пользователя к любому товару на примере

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

Источник статьи: http://checkroi.ru/blog/how-to-write-a-user-manual/

Как написать инструкцию так, чтобы тебя поняли

Есть такая поговорка: «Хочешь сделать хорошо — сделай сам».

Для себя, действительно, так будет быстрее и спокойнее. Однако любому руководителю известно, что плохой менеджер это тот, кто не умеет объяснять и делегировать полномочия. Соответственно, умение давать четкие инструкции и план действий — задача хорошего руководителя. А помогает ему в этом «юзабельность». Давайте и разберёмся с этим понятием.

Юзабилити (от англ. usability) означает удобство в использовании, эргономичность и легкость в понимании.

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

Итак, а теперь непосредственно к главному.

Выражение: «И так сойдет» — точно не для инструкций.

1. Постановка цели: для кого и для чего инструкция предназначена. Здесь следует упомянуть, что не следует памятку перегружать терминологией, иначе к ней будет прилагаться словарь терминов — целая энциклопедия и, увы, мало шансов, что её прочитают.

2. Не используем в инструкции много сленга. Есть шанс, что не все сотрудники его поймут.
Пример: «Уточнить у манагеров, получила ли апрув статья». С одной стороны, написано всё понятно, но для официального документа такой сленг не подходит.

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

Примеры скриншотов с вполне понятными шагами:

4. Не пропускаем шаги, которые кажутся нам слишком простыми. Пусть лучше сотрудник, читая инструкцию, сам пропустит этот степ.

5. В тексте нежелательно использовать большие предложения. Коротко: «Зайдите в меню», «Добавьте значение…», «Выберите параметр…» и т.д.

6. Для сокращения объема текста возможно применение графических элементов. Например,

Local area connection —–> properties–>TCP/IPv4–>properties.

7. Применение шрифтовых выделений допустимо. Это привлекает внимание на особо важных пунктах.

8. Не используйте в инструкции ничего из вашего личного опыта применения того или иного продукта или использования программы. Для этого существуют отдельные встречи с сотрудниками, где вы передаете им свой ценный опыт. А инструкция — это логичная структура, где описан «шаг — действие» и ничего более.

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

Эффективная юзабельная инструкция — это не простая формальность, это один из шагов к успешности и автоматизации рабочего процесса. Зеркальный юзабилити эффект заключается в том, что вещи, которые имеют отношение к собственного опыту, мы запоминаем лучше, чем те, которые не имеют к нам никакого отношения. Поэтому написание инструкций и памяток прокачивает менеджерские навыки специалистов. А это, в свою очередь, идет в «копилку скилов».

Источник статьи: http://habr.com/ru/company/icl_services/blog/421503/

Мануал что это такое, для чего нужен и как его составить (написать, сделать)

Здравствуйте, уважаемые читатели блога: My-busines.ru. Из содержания предлагаемой вашему вниманию статьи вы сможете узнать о том, что такое мануал.

Что это такое

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

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

Для чего нужен

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

Формат

Наиболее распространенными являются следующие форматы: PDF, Word, HTML. Рассмотрим каждую из этих разновидностей форматов более подробно.

PDF-формат наиболее распространен, потому как он является межплатформенным. Изначально данный формат был создан фирмой Adobe Systems с использованием специального языка PostScript. Наиболее подходящей программой для открытия данного формата является Adobe Reader.

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

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

Как составить (написать, сделать) мануал

Написание грамотного мануала включает в себя следующие этапы:

Указание темы. В границах и сфере темы необходимо быть предельно внимательным и точным;
Определение аудитории, для которой составляется (новички, профессионалы, люди со средними знаниями, будут ли изучать самостоятельно или же коллективно);
Выбор количества разделов;
Выбор названий разделов;
Выбор логической структуры изложения материала. Взаимосвязь разделов должна определяться исходя из последовательности действий;
Составление словаря терминов, если планируется использование специальных жаргонизмов. Его необходимо будет обновлять по мере написания;
Определение тем, которые требуют дополнительного исследования. Если вы не уделите подготовке мануала должного внимания, то от него не будет абсолютно никакой пользы. По этой причине очень важно закончить проведение различного рода дополнительных исследований до того, как вы приступите к написанию;
Определение структуры каждого из разделов;
Организация логической последовательности каждой секции и каждого раздела, постепенно сужая границы темы.

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

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

Изображения обязательно должны быть подогнаны под размеры текста.

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

После того как мануал будет написан, обязательно все проверьте. А еще лучше перепроверьте. И желательно не один раз. В случае обнаружения каких-либо ошибок немедленно исправляйте их. Также очень важно делать заметки об обнаруженных ошибках. Если вы считаете, что какой-то раздел может показаться другим людям непонятным, лучше его переписать. Также имеет смысл дать прочитать написанный вами текст разным людям. Только так вы сможете удостовериться в том, что написали все правильно.

Проверять готовый мануал лучше всего в следующей последовательности:

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

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

Источник статьи: http://my-busines.ru/useful/manual-chto-jeto-takoe-dlja-chego-nuzhen-i-kak-sostavit-napisat-sdelat-manual

Здравствуйте, уважаемые читатели блога: My-busines.ru. Из содержания
предлагаемой вашему вниманию статьи вы сможете узнать о том, что такое мануал.

Содержание

1 Что это такое
- 1.1 Для чего нужен
- 1.2 Формат
2 Как
составить (написать, сделать) мануал

Что это такое

Для чего нужен

Формат

Как
составить (написать, сделать) мануал

Написание грамотного мануала включает в себя следующие этапы:

Указание темы. В границах и сфере темы необходимо быть предельно внимательным и точным;
Определение аудитории, для которой составляется (новички, профессионалы, люди со средними знаниями, будут ли изучать самостоятельно или же коллективно);
Выбор количества разделов;
Выбор названий разделов;
Выбор логической структуры изложения материала. Взаимосвязь разделов должна определяться исходя из последовательности действий;
Составление словаря терминов, если планируется использование специальных жаргонизмов. Его необходимо будет обновлять по мере написания;
Определение тем, которые требуют дополнительного исследования. Если вы не уделите подготовке мануала должного внимания, то от него не будет абсолютно никакой пользы. По этой причине очень важно закончить проведение различного рода дополнительных исследований до того, как вы приступите к написанию;
Определение структуры каждого из разделов;
Организация логической последовательности каждой секции и каждого раздела, постепенно сужая границы темы.

Изображения обязательно должны быть подогнаны под размеры текста.

Проверять готовый мануал лучше всего в следующей
последовательности:

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

Маркетолог, вебмастер, блогер с 2011 года. Люблю WordPress, Email маркетинг, Camtasia Studio, партнерские программы)) Создаю сайты и лендинги под ключ НЕДОРОГО. Обучаю созданию и продвижению (SEO) сайтов в поисковых системах. Мои контакты >>>

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

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

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

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

Определить целевую группу

Прежде чем начать писать документацию, необходимо определить, для кого она будет предназначена? Кто будет использовать продукт?

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

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

Если аудитория состоит из людей старшего поколения, то используйте хорошо читаемый разборчивый шрифт.
Если же она представлена разработчиками, то нет необходимости объяснять базовые шаги в ОС Windows.
Если вы пишите для дислексиков, то делайте предложения короткими и используйте простые термины.

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

Понять, как будет использоваться продукт

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

Вот два примера, которые помогут выделить отличия этих двух принципов.

Функционально-ориентированное название главы: “Использование мастера экспорта”.
Задачно-ориентированное название главы: “Экспортирование данных проекта”.

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

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

В этом случае рекомендуется спросить себя следующее.

Что будут делать пользователи с продуктом?
Почему они его используют? Какова их цель?

Лучше всего будет пригласить группу пользователей и провести с ними обсуждение. Целью будет определить их задачи и, в идеале, дать им название на языке пользователей. Если же возможности собрать группу реальных пользователей у вас нет, то есть еще одно решение: пригласить коллег, которые по своей работе близко с ними связаны (например, продакт-менеджеров, проектных менеджеров, маркетологов или специалистов поддержки).

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

Начните с инструкций

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

Инструктивная глава дает пользователю пошаговый алгоритм действий.

Советы по написанию инструктивных глав

Вот несколько советов, которые нужно учесть при написании инструктивных глав.

Начинайте название главы с существительного. Пример: “Экспортирование данных проекта”.
Структурируйте инструктивные главы в виде нумерованного списка. Каждый этап задачи должен представлять один пункт списка.
Инструктивная глава не должна превышать 11 шагов. Большее число шагов излишне ее удлинит, снизив удобство чтения. Если в итоге у вас получается длинная глава, то поделите ее на подразделы.
Описывайте шаги в императивной форме. Пример: чтобы экспортировать данные проекта, нажмите на значок “Экспорт”.
Не предоставляйте подробной информации о возможности продукта или о том, как он работает. Вместо этого сосредоточьтесь на выполняемых пользователем шагах. Главы с сопутствующей информацией относятся к следующему этапу руководства.

Далее приводится пример того, как должна быть отформатирована и написана инструктивная глава.

Пример инструктивной главы

Добавление сопутствующей информации

После написания инструкций спросите себя: “Что нужно знать пользователям (чего они еще не знают) для выполнения всех этих инструкций?”

Перед каждой инструктивной главой добавляйте концептуальные. Они будут объяснять особенность ПО, необходимую для выполнения инструкций. В примере “Экспортирование данных проекта” одна глава может быть посвящена мастеру экспорта и поддерживаемым форматам данных.

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

Советы по написанию сопутствующей информации

Вот несколько советов, актуальных при написании концептуальных глав.

Не добавляйте в заголовках описательные приставки типа “О…” или “Сведения о…”. Называйте только сам принцип или функцию, которую хотите описать. Почему? Когда вы ищете что-либо по теме в интернете, то не вводите “Сведения о затмении”. С большей вероятностью вы будете искать по запросу “Затмение”. Когда пользователи ищут принципиальную информацию, они действуют аналогично, например пишут запрос “Мастер экспорта”.
Добавляйте только такие концептуальные главы, которые помогут пользователям выполнить инструкцию. Вероятно, вы вложили немало усилий в разработку бэкенда, необходимого для работы конкретной функции. При этом сложности, связанные с ее реализацией, не должны отражаться в документации. Единственное исключение — когда пользователю нужно знать эти детали для выполнения инструкций. Перед написанием концептуальной главы всегда спрашивайте себя: “Зачем пользователю нужно это знать?”.
Связывайте описательные главы с соответствующими инструктивными и наоборот.

Пример главы с сопроводительной информацией

Добавление справки

Последний компонент — это справка. Справочные главы содержат информацию для поиска в виде таблиц. В этих таблицах вы описываете графический интерфейс пользователя (GUI) и API.

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

Советы по написанию справочной информации

Заголовок справочной главы должен совпадать с элементом GUI или описываемой в ней функцией, например “Диалоговое окно мастера экспорта”.
Обязательно называйте элементы GUI так же, как они названы в самом GUI. Пользователи зачастую копируют названия элементов и вставляют их в строку поиска.
Подумайте, какая информация поможет пользователю, ищущему конкретный элемент GUI. Возможно, он как-то связан с другими элементами GUI или ограничениями. Задокументируйте их в справочной главе.

Примеры справочных глав

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

Я не стал детально объяснять, почему рекомендую структурировать и писать руководства именно так. Моей целью было научить вас делать это максимально быстро.

При этом нужно иметь в виду, что даже идеально структурированная документация ничего не стоит, если само содержание читать невозможно. Так что не забывайте основы.

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

Помните, что мануалы мы читаем не ради удовольствия, а от необходимости.

Туториал для туториалов. Как написать пользовательскую документацию

Время на прочтение
12 мин

Количество просмотров 14K

Есть устоявшеёся мнение, что для хороших продуктов руководство пользователя не нужно. Очередной холивар на эту тему разгорелся в нашем рабочем чате. Я не до конца согласен с этим утверждением.

Хороший интерфейс действительно должен помогать пользователю быстро понять продукт и научиться им пользоваться. Как всегда есть пара НО.

Пользователи бывают разные. То есть они могут отличаться как по возрасту, отрасли и опыту, так и по количеству мотивации. Мотивация особенно касается 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. буду благодарен за конструктивный фидбек в комментариях и ещё больше, если поделитесь вашим опытом.

Загрузить PDF

Руководство пользователя — это справочник на бумажном или цифровом носителе (в формате PDF или XPS), в котором приводятся инструкции по эксплуатации чего-либо или описывается правильный порядок действий для совершения какого-нибудь процесса. Хотя когда человек слышит словосочетание «руководство пользователя», он обычно представляет руководство по использованию определенной программы, инструкции по эксплуатации есть у компьютерной и бытовой техники (телевизоры, стерео-системы, телефоны, мп3-плейеры, садовая техника и и т.д.). Хорошее руководство пользователя рассказывает об основных функциях прибора или программы и объясняет, как правильно ими пользоваться, при этом информация обычно хорошо структурирована. Эта статья расскажет, о чем важно помнить при создании и оформлении руководства пользователя.

1
Определите, кто ваш читатель. Чтобы создать хорошее руководство пользователя, нужно понимать, какой человек купит то устройство, к которому вы создаете инструкцию. Можно записать свои мысли, а можно просто представить себе этого человека. Это полезно делать, если вы работаете в команде по созданию документации и если вы участвуете в разработке продукта от самого начала до конца. Подумайте о следующем:
- Где человек будет пользоваться инструкцией по эксплуатации: дома, на работе, в машине, в интернете? Это определит не только содержание, но и стиль документации.
- Как человек будет пользоваться инструкцией? Если человеку потребуется лишь изредка заглядывать в руководство пользователя, значит, инструкция должна быть оформлена в сжатой форме. Если руководством будут пользоваться часто, особенно в самом начале, вам следует включить целый раздел о том, как начать пользоваться устройством или программным продуктом, и подробно описать все самые важные функции.
- Как много опыта должно быть у человека? Если ваш товар относительно новый или существенно отличается от похожих товаров, вам нужно будет включить информацию о том, чем этот товар отличается от аналогов, и предоставить пользователю подробные инструкции. Если товар связан с частыми проблемами (например, с большим количеством программ), опишите, что следует делать, когда проблема возникнет.
2
Пишите так, чтобы читатель вас понял. Если только ваш товар не предполагает наличие узких знаний у пользователя, лучше избегать технических терминов и описывать все простым, понятным языком. Структура текста должна соответствовать последовательности вопросов, которые могут возникать у пользователя. Правильнее группировать функции прибора в зависимости от задач, которые он выполняет, и отказаться от идеи объединения в одну группу самых популярных функций.
- Иногда полностью исключить технические термины невозможно (например, если вы составляете инструкцию к программе для создания графиков и диаграмм, где помимо стандартных средств также используются графические инструменты Фибоначчи). В этом случае полезно дать определение термину и краткое описание (то есть что такое графики Фибоначчи и как они используются в анализе финансовых показателей).
3
Опишите проблему, с которой может столкнуться пользователь, а затем предложите решение. Когда вы рекламируете какой-то продукт, фразы о том, как он сможет решить определенную проблему, несомненно привлекут много внимания. Но когда пользователь купит этот продукт, ему нужно объяснить, что с ним делать. Опишите, с какими проблемами может столкнуться пользователь в процессе эксплуатации, и включите в руководство инструкции по разрешению этих проблем.
- Если проблема сложная, разбейте ее на несколько частей. Составьте список и сопроводите каждый пункт инструкциями. Это называется разбивкой на блоки.
Реклама

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

Ссылки на дополнительную документацию разместите в введении. Если руководство состоит из нескольких брошюр, укажите все номера брошюр в начале. Кроме того, здесь также следует разместить раздел «Как использовать эту инструкцию по эксплуатации», если вы решили, что такой раздел необходим.
3

Если количество страниц превышает 10 штук, вам понадобится оглавление.
4
Основу руководства по эксплуатации должны составлять инструкции и информация о составных частях товара. Как правило, инструкции разбивают на блоки, и в каждом блоке можно указать, в каких разделах пользователю стоит искать ту или иную информацию. Так пользователю будет проще и быстрее находить нужные ему сведения.
- Процессы должны быть описаны четко и последовательно. Начните с общего описания задачи, затем объясните, что пользователю нужно будет сделать и какой результат он должен будет получить. Все шаги должны быть пронумерованы, а начинаться предложения должны с глаголов.
- Справочные материалы должны включать список функций, способы диагностирования неисправностей и часто задаваемые вопросы. В конце руководства пользователя можно разместить краткий словарь терминов и алфавитный указатель, хотя основные термины часто выносятся в начало. Алфавитный указатель рекомендован для инструкций, чей объем превышает 20 страниц.
5
Используйте изображения и схемы. Рисунки и скриншоты могут описать определенные процессы лучше, чем текст, особенно если речь идет от сложных процессах, где необходимо иметь визуальное подтверждение тому, что человек все делает верно. Графические изображения можно создать в специальных программах: в системах двух- и трехмерного черчения, в графических редакторах, в приложениях для обработки фотографий и т.д. Если необходимо сделать скриншоты, их можно получить с помощью штатных средств комьпютера и графической программы с возможностью сохранения скриншотов.
- После того, как получите графическое изображение, сохраните его в сжатом формате. Вам также может потребоваться уменьшить размер рисунка, чтобы он помещался на страницу, но размер не должен быть слишком маленьким, так как иначе пользователь не сможет рассмотреть, как и что следует делать. Если потребуется, можно разбить изображение на несколько частей и описать каждую из них.
- Если вы используете несколько изображений, они должны иметь одинаковый размер, пропорции и разрешение. Такие изображения будут более понятны и приятны читателю. При создании скриншотов убедитесь, что вы используете стандартную цветовую схему (для случаев, когда руководство печатается в цвете).
- Хотя графические редакторы (например, Photoshop и Paint Shop Pro) удобны для создания скриншотов, лучше пользовать специальными программами (например, SnagIt), поскольку они позволяют сразу же быстро и легко отредактировать, сохранить и подписать все изображения.
Реклама

1
Выберите читаемый шрифт. Хотя компьютеры поддерживают разные шрифты, руководство пользователя должно быть хорошо читаемым, поэтому отдавайте предпочтение самым простым. Лучше всего подобрать несколько шрифтов, которые хорошо смотрятся вместе. Есть два типа шрифтов: с засечками и без засечек.
- У шрифтов с засечками есть небольшие черточки по краям линий. К таким шрифтам относятся Times New Roman, Baskerville и Book Antiqua. Такие шрифты подойдут большим объемам текста, напечатанного 10 или 12 размером и составляющего основу руководства пользователя.
- Шрифты без засечек имеют простые линии без украшений. Это такие шрифты, как Arial, Calibri и Century Gothic. Шрифты без засечек лучше смотрятся в текстах, напечатанных 8 или 10 шрифтом в руководствах в формате PDF или web-документа. Чем крупнее шрифт, тем сложнее его читать без засечек. Однако эти шрифты можно использовать и для крупного текста — например, для набора заголовков. Шрифты без засечек подходят для набора цифр в таблицах и колонках.
- Следует выбирать простые шрифты наподобие Arial или Times New Roman, хотя для цитат подойдет какой-нибудь более сложный шрифт. Если вы пишете руководство пользователя для фэнтезийной игры, можно выделить витиеватым шрифтом названия глав. Допускается также выделение цитат курсивом.
- После того, как выберите шрифты, создайте тестовую страницу, чтобы убедиться, что эти шрифты сочетаются между собой на бумаге. Покажите эту страницу человеку, который одобряет макеты, прежде чем отдать руководство пользователя в печать.
2
Продумайте схему расположения информационных блоков. На этом этапе вам нужно решить, в каком порядке размещать информацию.
- Как правило, название руководства пользователя и названия глав размещаются сверху или снизу страницы вместе с нумерацией страниц. Цифры могут располагаться с внешней стороны (для верха и низа страницы) или по середине (для низа). Первая страница каждого раздела может отличаться от остальных, поэтому вы можете разместить номер ее страницы по середине снизу, а номера всех остальных страниц — с внешней стороны.
- Отдельные фрагменты текста можно выделить цветом, поместив их в специальные блоки. Важно выбрать такой оттенок, который не забивал бы текст.
- Оставьте достаточно большие отступы со всех сторон. Со стороны переплета отступ должен быть шире.
3
Подумайте над типом переплета. Если в вашем руководстве пользователя больше 4-х страниц, вам потребуется переплет. Документы для внутреннего пользования обычно скрепляют степлером в углу, но если вы будете вкладывать свое руководство в коробку с товаром, вам нужно будет подойти к этому вопросу более ответственно. Есть три типа переплета:
- Скрепление скобой. Этот тип подходит для брошюр размерами 21x 27.5 см, 21×35 см или 11 x 27.5×42.5 см. Большинство недорогих инструкций по эксплуатации, которые состоят из 48 страниц и менее, переплетаются таким образом.
- Переплет внакидку. Так переплетают большинство обычных инструкций по эксплуатации, не считая инструкций к автомобилям, хотя некоторые длинные руководства также переплетаются таким образом. (Paint Shop Pro изначально поставлялся именно с таким руководством пользователя.)
- Переплет с проволочной спиралью. Таким способом переплетают руководства, которые используются в более суровых условиях, например, на улице, где скобы могут с легкостью сломаться или разойтись. В некоторых инструкциях по применению с таким переплетом также встречаются ламинированные страницы, которые не промокают и не пачкаются в грязи.
4
Сверстайте документ. В большинстве текстовых редакторов и программ для публикации текста в интернете предусмотрена возможность верстки. По мере того, как вы будете набирать текст, он будет автоматически отображаться в выбранном шрифте. (Эта статья была изначально написана с помощью шаблона в Microsoft Word.) В этих программах также есть уже готовые шаблоны, которые вы можете изменить с учетом своих потребностей, вместо того, чтобы создавать шаблон с нуля.
- В текстовых редакторах и программах для публикации текста в интернете также есть функция создания «стилей», сохранения шрифтов и задания размеров для оглавлений, колонтитулов и основного текста. Можно выбрать из уже существующих стилей («Заголовок1», «Обычный», «Цитата») или создать свой собственный стиль и дать ему свое название. Рекомендуется называть стили по такой же системе, как это предусмотрено в программе. (Например, Microsoft Word создает такие названия, как «Заголовок1», «Заголовок2»; кроме того, есть еще подзаголовки.) Настраивайте программу заранее, чтобы вам не пришлось возвращаться к этому, когда вы будете заниматься написанием текста.
Реклама

Советы

По возможности пользуйтесь кодами полей или текстовыми переменными. Можно изменять их значения (например, название продукта, название главы руководства пользователя) и помещать их в документ в места, где вы обычно стали бы набирать слова вручную. Когда вы сделаете предпросмотр документа или подготовите его к печати, нужный текст подставится в переменные. Если изменится название товара либо если вы решите изменить название главы, вам будет проще поменять текст, заменив значение переменной.

Что вам понадобится

Текстовый редактор или программа для публикации текста в интернете
Графический редактор или программа для создания скриншотов

Об этой статье

Эту страницу просматривали 48 479 раз.

Была ли эта статья полезной?

В статье рассказывается:

Для чего нужна инструкция
Виды инструкций
5 критериев хорошей инструкции
6 этапов написания инструкции
Структура инструкции
9 советов по написанию отличной инструкции
Часто задаваемые вопросы про написание инструкций
Что делать дальше после публикации инструкции в блоге

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

Написанную инструкцию потребуется еще оформить, разбить на главки – шаги, к которым прикрепить фото. Если таковых нет, можно прибегнуть к помощи Ютуба. И после публикации работа не заканчивается. Вам нужно анализировать метрики (сколько человек просмотрели, дочитали и т. д.), общаться с пользователями, отвечать на их вопросы. В общем, предстоит много работы! Но давайте обо все по порядку.

Для чего нужна инструкция

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

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

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

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

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

Одним словом: то, что планируете писать у себя в блоге, должно быть простым, доступным, информативным, подробным и эффективным. Если инструкция так и не решила проблему читателей, вряд ли вы получите дополнительный поток подписок.

Виды инструкций

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

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

о строительстве чего-либо или же сборке какого-нибудь предмета мебели, процессора и т. д.;
по применению;
по принятию лекарственного препарата;
лайфхак по типу «Как создать/сделать…»;
кулинарный рецепт.

Перечень не весь, но тут обозначены наиболее популярные и распространенные запросы читателей.

К отдельной категории можно отнести «специфическую инструкцию», или узконаправленную. Речь идет про материалы из разряда:

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

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

Описательные

Описательная инструкция, как правило, не несет практического характера, скорее, она рекомендательная. Ее задача рассказать, что из себя представляет объект/услуга, о функциональности, достоинствах и недостатках, возможностях и областях применения, о составе и стоимости. Например:

Сценарные

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

Еще один образец того, как можно написать сценарную инструкцию:

«Включите стиральную машину с помощью кнопки СТАРТ. Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

Для понимания различия: обзор функций нового выпущенного смартфона – описательная, инструкция по поклейке обоев – сценарная.

Кроме того, формат инструкций может быть:

текстовым;
видео;
скринкастингом – запись всех действий с экрана компьютера или смартфона;
инфографичным – каждый этап сопровождается фотографиями;
голосовым;
FAQ – сервис по часто задаваемым вопросам.

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

5 критериев хорошей инструкции

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

Как правильно написать инструкцию:

Актуальность темы

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

При публикации постов на «Хабре», например, не стоит писать о темах, ориентированных на новичков. Даже если это то, что актуально, популярностью оно пользоваться не будет. Покопайтесь в больших объемах информации и найдите цепляющее содержание. Специализированные форумы, журналы и статьи вам в помощь.
Применение в деле

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

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

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

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

Помните: чтобы написать грамотную пошаговую инструкцию, вы сами напрямую должны были с этим столкнуться и прийти к успешному результату. Экспертное мнение и профессиональный опыт станут лишь дополнительными бонусами. Просто посмотреть инструкцию в Интернете и переписать ее себе – недостаточно. Детали крайне важны.

6 этапов написания инструкции

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

Поиск проблемы. Любая инструкция несет в себе решение задачи путем совершения определенных действий. Важно, чтобы проблема соответствовала общей тематике сайта или вашего блога.
Ориентирование в проблеме. Чтобы инструкция была хорошей, автор сам должен разбираться в вопросе. Это должен быть ваш опыт, а не взятый с просторов Интернета и непроверенный лично перечень действий.
План решения. Первым пунктом в этом деле будет обозначение проблемы, последним – результат описанных действий, все остальное – промежуточные шаги, которые позволили из первого пункта прийти к последнему. Главное – этапы должны быть простыми, понятными и информативными.
Подробность. Всегда можно что-то добавить на каждом этапе. Избегайте «воды», четко и объемно формулируйте идею каждого пункта.
Визуал. Добавляйте в инструкцию инфографику, фото и изображения, которые упростят процесс понимания каждого этапа. Однако имейте в виду, что визуальное сопровождение может быть уместным не везде. Например, в статье «Как правильно написать инструкцию по применению лекарственного препарата», перегруженность фотографиями станет лишней.
Советы и рекомендации. Люди доверяют больше опыту и жизненным советам, чем сухому тексту с алгоритмом действий. Используйте это там, где необходимо.

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

Кейс: VT-metall

Узнай как мы снизили стоимость привлечения заявки в 13 раз для металлообрабатывающей компании в Москве

Узнать как

Структура инструкции

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

План выглядит следующим образом:

Цель статьи

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

Не всегда это бывает просто. Как правило, название материала соответствует самим запросам пользователей, например: «В каком порядке смотреть фильмы Марвел», но если кроме релевантности заголовок еще будет цепляющим, это – гарантированный успех статьи. Очень эффективно срабатывают заголовки, начинающиеся с цифр, и лучше всего использовать не круглые числа типа 10, 20, а нечетные 12, 23, 7 и т. д.
Введение, или лид

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

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

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

9 советов по написанию отличной инструкции

Чтобы ответить на главный вопрос сегодняшней статьи – как написать инструкцию – важно учитывать следующие особенности ситуации.

Оцените уровень знаний читателя

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

Смотрим на целевую аудиторию:

Это известный фермер, работающий в лаборатории Илона Маска и готовящийся к высадке данной культуры на Марсе?
А может – огородник в возрасте, не готовый переплачивать за удобрения и тепличное оснащение?
Ученик пятого класса, который делает практическую работу по биологии?

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

Пожилому огороднику не будут понятны научные термины, которые использует фермер-лаборант, а школьнику не нужны огромные объемы помидор, для практической работы ему вполне хватит 1–2.

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

Проверьте, есть ли уже подобные инструкции

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

Готовьте серию инструкций

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

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

Проверяйте инструкции

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

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

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

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

Не переписывайте чужие инструкции

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

Отжимайте лишнюю «воду»

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

Неудачно написанная инструкция начинается примерно так:

У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.

Как правильно написать инструкцию в этом случае:

В данном гайде вы найдете 11 простых способов рисования круга в «Фотошопе». Руководство подойдет для версии СС 2015 и выше.

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

Без картинок – никуда

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

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

Редко, но бывает такое, что соответствующей фотографии нет, тогда вам на помощь приходит YouTube. Там-то есть все. Смо́трите видео, нажимаете на паузу и делаете скриншот. Если у вас есть больше свободного времени и желания, визуальное сопровождение вы можете нарисовать сами в графическом редакторе. Если наличие видео или фото может быть неудобно и неуместно, тогда ставьте анимацию.

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

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

Выдерживайте статью в одном стиле

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

Пример неверного написания:

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

Образец, как надо написать инструкцию, чтобы она была читабельной:

Цвет — это инструмент управления вниманием пользователя: он помогает выделять главное. В интерфейсе краски используются для передачи смысла, а не для оформления.

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

Неправильно (т. к. нет никакого четкого пояснения):

В интерфейсах должна быть простая и понятная навигация.

Старайтесь избегать местоимения «мы», по возможности.

Запреты тоже могут быть нескольких типов. Используйте каждый там, где это необходимо:

Самый мягкий вариант – «Не рекомендуется делать подобным образом».
Средний вариант – «Так поступать нельзя».
Категоричный и жесткий вариант – «Строго запрещено делать подобное».

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

Не забывайте о безопасности

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

Скачайте полезный документ по теме:

Чек-лист: Как добиваться своих целей в переговорах с клиентами

Часто задаваемые вопросы про написание инструкций

Каким категориям бизнеса рекомендуется использовать инструкции?

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

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

Чем инструкция отличается от обзора?

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

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

Как узнать, для какой аудитории пишется инструкция?

Как написать правильную пошаговую инструкцию, которая понравится потребителю? Все просто – пообщайся с клиентом.

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

Какой объем инструкции считается оптимальным?

По большому счету, это зависит от автора и самой темы инструкции, но, как показывает практика, чем короче руководство, тем лучше. Есть возможность уместить объяснение в одно-два предложения? Прекрасно! Читатели оценят.

Что делать дальше после публикации инструкции в блоге

Как написать инструкцию, мы разобрали, но что же делать, когда текст готов, проверен редактором, логичен, информативен и даже уже поставлен в пост? Для развития контента и увеличения трафика необходимо соблюдать следующее:

Регулярность выхода

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

Email-рассылки

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

Взаимодействие с читателями

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

Возможность оценки контента

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

Возможность делиться инструкциями

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

Сотрудничество с другими авторами

Сторонние площадки, подходящие вашей тематике, могут стать прекрасным полем развития блога. Общайтесь с другими авторами, работайте по бартеру – таким образом, вы сможете помочь друг другу повысить трафик, улучшить контент и увеличить популярность среди подписчиков.

Анализ инструкций

Анализ контента – важный фактор в успешном продвижении блога, в котором публикуются инструкции, лайфхаки и обзоры. Есть масса инструментов, способных в этом посодействовать, например, Яндекс.Метрика – раздел «Контент».

Там можете увидеть количество просмотров вашей инструкции, сколько времени на странице провели пользователи, сколько посетителей, прочитав один пост, перешли к другому, и т. д.

Подгрузка видео из YouTube

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

Наличие подкастов или голосовой записи инструкций

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

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

Статья опубликована: 01.03.2022

Облако тегов

Понравилась статья? Поделитесь:

Здравствуйте!

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

Сегодня вы узнаете, зачем нужны пошаговые руководства и где их можно использовать. Получите чёткий план написания статьи-инструкции с полезными советами.

Зачем нужны инструкции и где их можно использовать

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

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

Где использовать пошаговые руководства:

Правила составления и написания статей-инструкций

Контент должен быть:

полезным — решайте актуальную для вашей ЦА проблему;
подробным — расскажите в деталях обо всех этапах, нюансах и распространённых ошибках;
наглядным — подберите для своего материала инфографику, чек-листы, видео, скриншоты и иллюстрации;
структурированным — с подзаголовками, абзацами и списками для удобного восприятия читателем;
актуальным — если порядок действий, интерфейс программы, который вы описываете, меняется, то статью нужно обновлять;
экспертным — автор обязан хорошо разбираться в теме, желательно, писать на основе личного опыта.

Как сделать инструкцию экспертной, если вы не эксперт?

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

Это интересно: Как придумать цепляющий заголовок статьи

Как написать пошаговую инструкцию: наглядный пример

Рассмотрим поочерёдно все этапы.

1. Выбор темы

Выберите актуальную, полезную для вашей ЦА тему. Она обязана соответствовать тематике блога или сайта. Тема должна быть интересной пользователям и сейчас, и в перспективе — иначе нерационально вкладывать столько сил и времени на написание подробного гайда.

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

Запомните: одна инструкция — одна тема. Распыляться не стоит.

2. Выбор формата инструкции

Выберите наиболее подходящий вид руководства:

«Инструмент для…» — расскажите об инструменте/методике из вашей отрасли, которые мало кто использует правильно;
«Проблема и её решение» — озвучьте актуальную для ЦА проблему и предложите несколько практик, рекомендаций для её решения;
«Экспертная оценка» — проанализируйте новинку на рынке товаров, известный факт, событие или книгу, дайте полезный совет;
«Вопрос-ответ» — опишите проблемную ситуацию, с которой к вам обратился клиент, распишите подробно варианты решения;
«Практические рекомендации» — предоставьте читателям пошаговую методику решения проблемы (или несколько методик).

3. Выбор названия

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

Шаблоны заголовков:

«Простой/уникальный способ…»;
«Как…»;
«Краткая инструкция…»;
«Теперь вы сможете»;
«Создайте…»;
«Быстрое/бесплатное решение…»;
«10 шагов для…»;
«Метод…»;
«Это обязан знать каждый…»;
«Секрет…».

4. Глубокое изучение вопроса

Ваша задача — досконально изучить проблему аудитории и найти решение. Проведите личный эксперимент, на основе которого будете писать руководство.

5. Составление плана

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

6. Подробное рассмотрение всех шагов

Оформите каждый этап руководства как отдельный блок инструкции со своим подзаголовком.

Обычно структура этапов строится по следующей схеме:

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

7. Добавление визуального контента

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

8. Вычитка текста

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

Всё ли вам понятно в инструкции, нет ли сложных предложений и трудных терминов?
Перечислено ли то, что следует взять и проверить перед началом работы?
Соблюден ли порядок этапов, ничего не пропущено?
Учтены ли все подводные камни и тонкости, с которыми может столкнуться читатель?
Есть ли чересчур большие этапы, которые лучше разбить на отдельные блоки
Имеются ли ненужные подробности (их следует убрать, чтобы не размывать тему)?

9. Проверка уникальности

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

Проверить уникальность текстов можно с помощью специальных сервисов.

Заключение

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

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

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

Источник

Do you know what’s more important than selling a product? Making sure your customers are able to use it effectively.

That’s where a user manual comes in – it’s the key to helping your users understand your product and processes. And believe it or not, it can even be legally required for you to sell your products. But take note, a user manual isn’t just a legal requirement, it has a significant impact on your customer’s experience.

Research shows that customers prefer to consult user manuals before reaching out to a support team, which means your manual has the potential to save you money on support costs.

So, it’s essential to invest time and effort in creating a helpful user manual. In this post, we’ll share top tips on how to write an effective user manual, and highlight some software that can assist you in the process.

What is a user manual?

Imagine you’re trying to assemble a new piece of furniture you’ve just bought, and you’re stuck at some point.

The bolts won’t fit, and you’re scratching your head, wondering what to do next. Instead of giving up and tossing the pieces aside, you could reach for the user manual that came with the product.

A user manual can be a real lifesaver in such situations, and it’s not just for furniture assembly-whether it’s a new device, electronic gadget, or software application, a user manual can help you understand how to use it to its full potential. And for businesses, having a comprehensive user manual is a no-brainer.

It can save you money by deflecting common user queries and providing detailed documentation around your product or service.

Types of user manuals

When it comes to technical communication, user manuals are an essential component. And with so many different types of user manuals out there, it can be a bit overwhelming to decide which ones to use.

That’s why, before you start creating your user manuals, it’s important to consider your target audience and the purpose of your product.

Will your users be primarily tech-savvy? Do you need to provide detailed step-by-step instructions, or just a general overview? By answering these questions, you’ll be able to choose the right type of user manual that will effectively communicate the information your users need.

So take some time to think about it, and create a manual that will make your users happy and successful.

1. OwnerDiscover everything you need to know about the importance of product manuals, what type of information they should contain, and how to write a good one.’s Manual

An owner’s manual is a document that contains information about the care and operation of a product. Owner’s manuals are typically provided by the manufacturer of the product and can be found online or in physical form.

2. Instruction Manual

An instruction manual is a document that provides step-by-step instructions for how to use a product. Instruction manuals are typically provided by the manufacturer of the product and can be found online or in physical form.

3. Quick Start Guide

A quick start guide is a document that provides a brief overview of the main features and functions of a product. Quick start guides are typically provided by the manufacturer of the product and can be found online or in physical form.

4. User Guide

A user guide is a document that provides detailed information about the use of a product. User guides are typically provided by the manufacturer of the product and can be found online or in physical form.

5. Troubleshooting Guide

A troubleshooting guide is a document that provides information on how to resolve common problems with a product. Troubleshooting guides are typically provided by the manufacturer of the product and can be found online or in physical form.

6. Warranty Information

Warranty information is a document that provides details on the terms of a product’s warranty. Warranty information is typically provided by the manufacturer of the product and can be found online or in physical form

What makes a good user manual?

Plain language

The key to creating an effective manual is to use plain language. This means avoiding big words and complicated phrases that could confuse your readers. Instead, keep your sentences short and sweet, and use common terms that your audience will understand. Of course, there may be times when you need to use technical jargon, but make sure you define these terms or provide links to a glossary.

By using plain language, you’ll ensure that your manual is accessible to everyone, without compromising the clarity or professionalism of your writing.

Visuals

Relevant images, diagrams, and videos can break up the monotony and actually catch the attention of your users. But it’s not just about aesthetics — visuals can also help clarify instructions and make them easier to follow. So, if you want to create a user manual that’s both informative and engaging, be sure to incorporate some visuals. Trust us, your users will thank you for it!

Logical hierarchical structure

Have you ever tried to find information in a user manual and gotten lost in a sea of irrelevant topics? Yeah, it’s pretty frustrating.

That’s exactly why it’s important to have a logical hierarchical structure in place when it comes to your content. Think of it as a roadmap for your users to navigate through your information with ease. By providing a clear structure, you’re enabling them to quickly find what they’re looking for without the headache of sifting through a bunch of irrelevant information. So, next time you’re putting together a user manual, take some time to make sure your contents are laid out in a logical and easy-to-follow way.

Searchable content

It’s essential to have a searchable knowledge base that can help your users find the information they’re looking for in no time. But that’s not all. Your search bar should also be predictive, meaning it should suggest the terms your users are typing in. This way, they can easily find the content they need without the frustration of typing in keywords that don’t get them anywhere.

So, if you want to keep your users engaged and satisfied, make sure you have searchable content with a user-friendly search bar.

Clear topics and relevant articles

The key to making your content easily digestible for readers is to organize it with clear topics that are relevant to the articles themselves. Having too many topics can be off-putting for users, while too many levels of subtopics can make the documentation challenging to navigate.

So, keep things concise and user-friendly by structuring your content with just the right amount of topics and subtopics. Your readers will thank you for making it effortless to find and understand the information they need!

Feedback and reviews

It’s not always easy to put your work out there and have others critique it, but seeking feedback from your users can be incredibly valuable in improving your manual. After all, who knows better what works and what doesn’t than the people who are actually using it? Take their suggestions into account and see if there are any changes you can make to better enable them to solve their problems.

Remember, the whole point of a user manual is to help your users succeed. So, make sure you’re doing everything you can to make that happen.

Conclusion

It’s no secret that user manuals are important. They can make or break a user’s experience with your product or service. But did you know that creating one takes time and effort? Yeah, it’s not just a matter of slapping some instructions down on paper and calling it a day. Lucky for you, there are tools out there to help make the process a little easier. But, the key is to take your time and test out a few different options to find which one suits your organization’s needs best. Trust me, your customers (and your customer service team) will thank you for it.

Источник

Здравствуйте, уважаемые читатели блога: My-busines.ru. Из содержания
предлагаемой вашему вниманию статьи вы сможете узнать о том, что такое мануал.

Содержание

1 Что это такое
- 1.1 Для чего нужен
- 1.2 Формат
2 Как
составить (написать, сделать) мануал

Что это такое

Для чего нужен

Формат

Как
составить (написать, сделать) мануал

Написание грамотного мануала включает в себя следующие этапы:

Указание темы. В границах и сфере темы необходимо быть предельно внимательным и точным;
Определение аудитории, для которой составляется (новички, профессионалы, люди со средними знаниями, будут ли изучать самостоятельно или же коллективно);
Выбор количества разделов;
Выбор названий разделов;
Выбор логической структуры изложения материала. Взаимосвязь разделов должна определяться исходя из последовательности действий;
Составление словаря терминов, если планируется использование специальных жаргонизмов. Его необходимо будет обновлять по мере написания;
Определение тем, которые требуют дополнительного исследования. Если вы не уделите подготовке мануала должного внимания, то от него не будет абсолютно никакой пользы. По этой причине очень важно закончить проведение различного рода дополнительных исследований до того, как вы приступите к написанию;
Определение структуры каждого из разделов;
Организация логической последовательности каждой секции и каждого раздела, постепенно сужая границы темы.

Изображения обязательно должны быть подогнаны под размеры текста.

Проверять готовый мануал лучше всего в следующей
последовательности:

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

Источник

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

Виды инструкций

По содержанию инструкции бывают:

Описательные. Цель описательной инструкции – познакомить покупателя с товаром: рассказать о полезных функциях смартфона, возможностях сервиса, материалах оконного профиля или применении битумной мастики.

Пример:

Сценарные. Сценарная инструкция – это пошаговое руководство для решения конкретной задачи. Например, как заменить струны на гитаре, запустить автотаймер регистратора или сварить пельмени.

Пример:

«Включите стиральную машину с помощью кнопки СТАРТ.

Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

Материалы сборки велосипеда – описательная инструкция, а порядок замены пробитой шины – сценарная.

Еще инструкции разделяются по формату:

текстовые;
видеоинструкции;
скринкастинг – запись действий с экрана компьютера;
инфографика – подборка иллюстраций для быстрой передачи сути;
FAQ – справочный раздел сайта для ответов на популярные вопросы.

Продвинем ваш бизнес

В Google и «Яндексе», соцсетях, рассылках, на видеоплатформах, у блогеров

Подробнее

Правила составления текстовых инструкций

Структура

Типовая инструкция включает следующие разделы:

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

Спасибо!

Ваша заявка принята.
Мы свяжемся с вами в ближайшее время.

122 статьи по контент-маркетингу: императорская подборка полезностей

Оформление текста

Примеры:

Плохо	Хорошо
Для этого необходимо перейти в режим записи видео.	Перейдите в режим записи видео.
Ламинированное покрытие нужно протирать обычными моющими средствами.	Протирайте ламинированное покрытие обычными моющими средствами.
Все детали фурнитуры для получения легкого хода должны смазываться не реже 1 раза в год машинным маслом.	Смазывайте фурнитуру не реже 1 раза в год машинным маслом для получения легкого хода.

Примеры:

Плохо	Хорошо
Эта надпись говорит о вероятной поломке механизма.	Эта надпись говорит о поломке механизма.
Сбор данных скорее всего займет 10 минут.	Сбор данных займет 10 минут.

Примеры:

Плохо

Хорошо

Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Затем выберите в меню режим «Блок».

Удерживайте кнопку «Пуск» до появления желтой индикации на экране.
Выберите в меню режим «Блок».

Для регулировки створки вам потребуется шестигранник, шлицевая отвертка и монтажный клин.

Для регулировки створки вам понадобятся:

шестигранник;
шлицевая отвертка;
монтажный клин.

Примеры:

Плохо	Хорошо
Закрепите радиатор на стене. От правого края батареи отмерьте 10 см для установки воздуховода.	Закрепите радиатор на стене. От правого края радиатора отмерьте 10 см для установки воздуховода.

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

Плохо	Хорошо
Номинальная мощность микроволновки – 700 Вт.	Номинальная мощность микроволновой печи – 700 Вт.
Граната автомобиля передает крутящий момент на ось колеса.	Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса.

Примеры шрифтов:

С засечками	Без засечек
Допустимое напряжение в сети от 215 до 230 Вольт.	Допустимое напряжение в сети от 215 до 230 Вольт.

Иллюстрации

Как я стала писать для «Текстерры»: история бывшего копирайтера

Источник

0 ₽ 0 товаров

Каталог инструкций по эксплуатации на русском языке

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

Источник