Руководство образец написания

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

инструкции для сотрудников

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

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

3 основных вида инструкций

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

Пошаговая инструкция

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

Пошаговое руководство

Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:

  1. Откройте верхнюю крышку и извлеките блок фотобарабана
  2. Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
  3. Вытащите тонер-картридж
  4. Поставьте на его место новый
  5. Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
  6. Установите фотобарабан обратно в принтер
  7. Закройте крышку
  8. Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает обратитесь к системному администратору

Инструкция по использованию

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

инструкция по использованию

В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:

  • В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic 160-180°C.
  • Максимальное время работы ламинатора 4 часа. Затем нужно сделать получасовой перерыв.
  • Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его. 
  • Внимание! Не ламинируйте влажные образцы жидкость может повредить электронные компоненты!
  • После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством. 
  • Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию! 

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

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

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

Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:

  1. Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
  2. При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
  3. Бригадир раздает списки, по которым комплектуются грузы. 
  4. Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
  5. Если есть необходимость, грузчик может привлекаться к другим работам на территории склада уборке, контролю за въездом транспорта и пр.

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

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

Общие правила при подготовке инструкций

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

  • Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
  • Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
  • Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
  • Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
    Как структурировать много данных →
  • Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта

Алгоритм разработки руководства: 9 шагов

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

  1. Собрать информацию
  2. Сгруппировать ее по отдельным этапам
  3. Изложить последовательность выполнения каждого этапа с учетом уровня подготовки читателя

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

Шаг 1. Изучить ситуацию

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

Шаг 2. Разложить все на отдельные этапы

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

  1. Запустить программу Microsoft Word
  2. Создать новый документ
  3. Набрать необходимый текст
  4. Отформатировать его 
  5. Сохранить файл
  6. Сообщить в бухгалтерию, что заявление подготовлено 

Шаг 3. Описать каждый этап

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

Не стоит бояться слишком заурядных объяснений – скорее всего найдутся те, кто еще не знает этого, а остальные легко пропустят такое описание. Например, для тех, кто не работал с программой Word, нужно пояснить как создается файл:

2. Нажмите на раздел «Новый документ» в правой части экрана 

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

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

Шаг 4. Рассмотреть нестандартные варианты развития ситуации

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

3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры 

Шаг 5. Подобрать изображения и привести примеры

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

Шаг 6. Придумать заголовок

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

  • «Как написать инструкцию по подготовке заявления»
  • «6 шагов для подготовки электронного документа»
  • «Простой способ написать заявление на компьютере»
  • «Подробный алгоритм подготовки документа для безбумажного оборота»

Шаг 7. Оценить промежуточный вариант

В результате должен получиться подобный текст:

Как написать простую инструкцию (образец): 

  1. Запустите программу Microsoft Word
  2. Нажмите на раздел «Новый документ» в правой части экрана 
  3. Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
  4. Отформатируйте набранный текст с помощью верхней панели программы Word.
    • Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
    • Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
    • Выделите список спецодежды и примените к нему функцию «Маркированный список» 
  1. Сохраните файл. Для этого:
    • Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
    • Выберите путь сохранения файла
    • В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
    • Нажмите кнопку «Сохранить»
  2. Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено. 

Пример объявления, на который можете ориентироваться при подготовке:

Шаг 8. Тестирование

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

Проверьте алгоритм с помощью этих вопросов:

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

Шаг 9. Обучить сотрудников по инструкции

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

Особенности такого обучения:

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

Примеры готовых инструкций

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

Вывод

Резюмируя все изложенное, можно составить требования к идеальной инструкции:

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

Вам будет интересно

агрегаторы курсов

Готовые курсы для бизнеса: проверенные агрегаторы онлайн курсов

как учиться эффективно

Как учиться эффективно: проверенная технология обучения

платформы для вебинаров

Где провести вебинар: лучшие программы для вебинаров

Перейти на главную блога

На чтение 10 мин Просмотров 1.1к. Опубликовано 30.10.2021

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

Зачем писать практические руководства?

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

Например, посчитайте, сколько людей каждый день ищут в Google «Как [любое слово]»:

Как написать подробное руководство

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

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

Достаточно сказать: практические руководства стоит добавить в ваш арсенал контента.

Как сделать практическое руководство

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

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

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

  • Проведите исследование ключевых слов, чтобы узнать, что люди хотят узнать.
  • Используйте Ahrefs, SEMrush или любой другой инструмент SEO для определения похожих ключевых слов и запросов. Это может помочь вам создать всестороннюю статью, которая ответит на все вопросы ваших читателей и поможет вам получить рейтинг в Google.
  • Посмотрите на своих конкурентов, чтобы увидеть, как они пишут свои руководства.

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

Понять проблемы и проблемы вашей целевой аудитории.

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

Например, если вы пишете «Как создать стратегию контент-маркетинга», вы можете выполнить следующие действия:

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

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

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

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

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

Расскажите читателю, почему это важно.

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

Как написать практическое руководство

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

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

Существует огромная разница между читателями, которые ищут «Что такое запрос предложения?», И теми, кто ищет «Как написать запрос предложения?».

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

При написании практического руководства следует помнить о некоторых методах:

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

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

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

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

Есть ли разница в том, как вы пишете руководство пользователя и практическое руководство?

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

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

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

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

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

  1. Практическое руководство по рецептам.Как написать подробное руководствоНа сайте Гастроном аккуратно структурированы рецепты, поэтому читатели могут быстро определить: сколько времени займет приготовление, ингредиенты, которые им понадобятся, количество порций и т.д. Если читатель уже знает ингредиенты, он может щелкнуть «Инструкции», чтобы сразу начать. В качестве альтернативы, скажем, читатель предпочитает просматривать инструкции, а не читать, он может щелкнуть «Посмотреть видео с практическими рекомендациями». Это предлагает хороший выбор для посетителей, которые по-разному потребляют контент.

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

  2. Практическое руководство для B2B.В статье Atlassian «Как написать идеальный 90-дневный план» приведены важные контекстные детали для 90-дневного плана, в том числе «Что такое 90-дневный план?» и «Что должно быть включено в 90-дневный план?» Публикация хорошо проработана и написана с сочувствием.Лучше всего то, что в руководстве есть загружаемый PDF-файл с 90-дневным планом, так что читатели могут сразу загрузить и использовать план Atlassian со своей командой.

    Вывод: подумайте, какие электронные книги, PDF-файлы, диаграммы, дизайны Canva или Google Таблицы вы можете создать самостоятельно и предложить читателям для загрузки. Читатели оценят возможность немедленно применить то, что они узнали.

  3. Практическое руководство для B2C.Руководство «Как стать фрилансером» от FlexJobs отлично справляется с предоставлением соответствующих ссылок и данных для создания всестороннего обзора того, что такое фриланс. Кроме того, в сообщении используются глаголы действия, чтобы вдохновить читателя.В разделе «Как начать внештатный бизнес». вы увидите такие советы, как «Делайте домашнее задание», «Создайте бренд» и «Планируйте заранее». Язык, использованный в этом посте, во многом побуждает читателей немедленно приступить к работе.

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

  4. Практическое руководство по продукту.Статья How-To Geek под названием «Как найти данные в Google Таблицах с помощью ВПР» не обязательно является самой интересной темой. Тем не менее, бренд эффективно поддерживает интерес к контенту с помощью чутких заявлений вроде: «ВПР может показаться запутанным, но это довольно просто, если вы поймете, как это работает».Кроме того, How-To Geek включает полезные оригинальные изображения, демонстрирующие каждый совет, который они описывают. Эти изображения не обязательно должны быть ультрасовременными визуальными эффектами, созданными профессиональной командой дизайнеров — как показывает этот пост, несколько простых снимков экрана имеют большое значение для того, чтобы помочь читателям понять сложную тему.

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

  5. Практическое руководство по образу жизни.Еще один пример — пост на Medium под названием «11 способов быстро избавиться от стресса в вашей жизни». Ожидается, что в ней будет нескольких простых и быстрых советов, как избавиться от стресса. Но первый раздел поста — «Влияние стресса на вашу жизнь». В этом случае важно, чтобы читатели понимали, почему, а не как .

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

Шаблон для написания практического руководства можно получить как гуглдок здесь. Чтобы сохранить к себе, нажмите Файл -> Создать копию. Там же шаблоны и других материалов для блога.

Статья является адаптированным переводом https://blog.hubspot.com/marketing/how-to-guide.

Читайте также:

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

Photo by James McKinven on Unsplash.

Писать руководство пользователя по шаблону. Удобно? Удобно

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

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

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

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

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

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

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

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

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

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

В связи с этим, мы сами создали готовые образцы и костяки шаблонных проектов в программе. Что входит в нашу базу:

  • Руководство пользователя программного обеспечения.

  • Руководство пользователя web-сервиса.

  • Корпоративная база знаний компании.

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

Вы бережете своё время.

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

Вы сосредотачиваете внимание на вашей программе, а не на создании файл-справки

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

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

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

 Адаптация шаблонов и образцов под ваш проект.

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

О шаблонах

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

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

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

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

Особые случаи. Здесь нужно рассказать пользователю про то, какие трудности могут возникнуть и как их решить, выделить часто задаваемые вопросы и дать на них самый доступный ответ. Подразделы: «FAQ» и «Устранение типовых проблем»

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

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

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

Как написать статью-инструкцию или пошаговое руководство

author__photo

Содержание

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

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

Где использовать статьи-инструкции

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

Пошаговые руководства публикуются:

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

Правила написания

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

  • Правильно выбирайте ЦА. Ответьте на вопрос: кто будет читать пошаговое руководство? Гайд для новичков — это одно. Инструкция для тех, кто уже разбирается в теме и хочет прокачать скилы, — совсем другое.

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

  • Досконально разбирайтесь в вопросе. Гайды пишут эксперты или копирайтеры. 

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

При выборе темы убедитесь, что она соответствует тематике вашего блога или сайта, а главное — актуальна и интересна ЦА. Запомните формулу: один гайд — один вопрос. Распыляться не стоит, иначе статья получится громоздкой и ее будет неинтересно читать.

  • Составляйте план будущего руководства. Основа любой инструкции — хорошо продуманные тезисы. 

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

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

  • Перечитывайте готовый текст несколько раз и убирайте «воду». У человека, который читает гайд, нет времени искать нужную информацию среди «каждому известно» и «актуальность проблемы трудно переоценить».

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

Убирайте из инструкции канцеляризмы, штампы и стоп-слова — читатели не дочитывают такие статьи до конца. Проверяйте тексты на «воду» в таких сервисах, как «Адвего», Istio.com и Text.ru. Норма — 55–75%, но она может варьироваться в зависимости от тематики.

  • Добавляйте картинки и примеры. Гайд без визуального сопровождения — это не гайд.

Добавляйте в текст скриншоты или фотографии, GIF-анимацию и инфографику с диаграммами, блоками и схемами. Они сокращают объем руководства, структурируют информацию, делают ее нагляднее.

Берите на заметку бесплатные сервисы для создания инфографики: Сanva, Easel.ly, Piktochart, Venngage. И еще несколько ресурсов для создания GIF-анимации: Gifovina, Gifs (создает анимацию из видео на YouTube) и Online-convert.

Алгоритм написания

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

Шаг 1. Подготовка и сбор информации

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

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

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

Скрупулезное исследование клиентских обращений поможет улучшить продукт и доработать УТП. Воспользуйтесь Речевой аналитикой Calltouch Predict, чтобы изучить, кто и по каким вопросам звонит в вашу компанию. Сервис определит пол каждого звонящего, присвоит тег, запишет диалог клиента и оператора и переведет его в текст. Вы поймете, чего не хватает вашим клиентам, и на основе их обращений оптимизируете скрипты продаж или даже сам продукт.

caltouch-platform

Технология
речевой аналитики
Calltouch Predict

  • Автотегирование звонков
  • Текстовая расшифровка записей разговоров

Узнать подробнее

platform

Шаг 2. Структурирование 

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

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

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

Заключение — итоги статьи. Сделайте эту часть полезной для читателя. Составьте памятку с краткими выводами, по которым удобно делать то, о чем было подробно рассказано в основной части вашего руководства. Для этого перечислите 5–7 основных тезисов или сделайте выжимку рекомендаций по типу той, которая будет в конце этой статьи.

Заголовок (H1) должен быть коротким, но емким. Вот несколько примеров, которые можно взять на заметку:

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

Внутренние подзаголовки (H2, H3…) разделяют информацию на блоки или являются этапами пошаговой инструкции — это зависит от объема текста.

Шаг 3. Написание текста

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

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

Шаг 4. Завершение

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

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

caltouch-platform

Сквозная аналитика Calltouch

  • Анализируйте воронку продаж от показов до денег в кассе
  • Автоматический сбор данных, удобные отчеты и бесплатные интеграции

Узнать подробнее

platform

Вместо вывода

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

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

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

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

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

Ежедневные советы от диджитал-наставника Checkroi прямо в твоем телеграме!

Подписывайся на канал

Подписаться

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

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

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

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

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

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

Пошаговая инструкция по написанию руководства пользователя

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

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

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

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

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

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

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

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

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

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

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

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

Приятного чтения.

Если перед вами стоит вопрос – нужно ли вашему продукту пользовательское руководство, то отвечу сразу – да, нужно. Почему? На это есть две причины:

1. Качественная документация повышает лояльность клиента и ценность продукта в целом.

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

2. Руководство пользователя экономит время и силы техподдержки.

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

А теперь к советам!

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

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

— Где скорее всего пользователи будут прибегать к документации? (дома, на работе, в машине)

— Насколько объективно сложен для понимания продукт и как часто пользователь будет обращаться к документации?

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

(Для изложения лучше всего выбрать нейтрально-формальный стиль)

Структура руководства пользователя

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

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

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

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

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

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

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

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

Профессиональный совет: если вы хотите максимально облегчить ношу клиента при чтении документации создайте контекстно-зависимую справку. Что это такое?

Представьте, что вы работаете в программе для создания пользовательской документации. Открываете меню основных настроек и видите раздел «аннотирование экрана» Заходите в него, там показаны разные стили аннотации, тени, фон и так далее. Но что такое аннотация? Допустим вы не знаете — нажимаете кнопку F1 и перед вами открывается руководство именно на той странице, где рассказано об «аннотировании экрана»

Как ее сделать? Смотрите ниже.

Контент

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

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

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

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

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

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

3. Видео.

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

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

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

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

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

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

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

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

Инструменты

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

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

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

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

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

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

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

Какой можно сделать вывод

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

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

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

Спасибо за внимание!

Со всеми возможностями Dr.Explain можно ознакомиться здесь:

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.

Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».

Ниже приведен состав руководства пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).

Разделы руководства пользователя:

  1. Введение.
  2. Назначение и условия применения.
  3. Подготовка к работе.
  4. Описание операций.
  5. Аварийные ситуации.
  6. Рекомендации по освоению.

1. Введение

В разделе «Введение» указывают:

  1. область применения;
  2. краткое описание возможностей;
  3. уровень подготовки пользователя;
  4. перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю.

1.1. Область применения

Требования настоящего документа применяются при:

  • предварительных комплексных испытаниях;
  • опытной эксплуатации;
  • приемочных испытаниях;
  • промышленной эксплуатации.

1.2. Краткое описание возможностей

Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех аспектах финансово-хозяйственной деятельности Компании.

ИАС КХД предоставляет возможность работы с регламентированной и нерегламентированной отчетностью.

При работе с отчетностью используется инструмент пользователя Oracle Discoverer Plus, который предоставляет следующие возможности:

  • формирование табличных и кросс-табличных отчетов;
  • построение различных диаграмм;
  • экспорт и импорт результатов анализа;
  • печать результатов анализа;
  • распространение результатов анализа.

1.3. Уровень подготовки пользователя

Пользователь ИАС КХД должен иметь опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими знаниями:

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

Квалификация пользователя должна позволять:

  • формировать отчеты в Oracle Discoverer Plus;
  • осуществлять анализ данных.

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

  • Информационно-аналитическая система «Корпоративное хранилище данных». ПАСПОРТ;
  • Информационно-аналитическая система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.

2. Назначение и условия применения Oracle Discoverer Plus

В разделе «Назначение и условия применения» указывают:

  1. виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
  2. условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных.

Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе.

Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа.

3. Подготовка к работе

В разделе «Подготовка к работе» указывают:

  1. состав и содержание дистрибутивного носителя данных;
  2. порядок загрузки данных и программ;
  3. порядок проверки работоспособности.

3.1. Состав и содержание дистрибутивного носителя данных

Для работы с ИАС КХД необходимо следующее программное обеспечение:

  1. Internet Explorer (входит в состав операционной системы Windows);
  2. Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД.

3.2. Порядок загрузки данных и программ

Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия:

  1. Необходимо зайти на сайт ИАС КХД ias-dwh.ru.
  2. Во время загрузки в появившемся окне «Предупреждение о безопасности», которое будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator» …’ Нажимаем на кнопку «Да».
  3. После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK.

3.3. Порядок проверки работоспособности

Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия:

  1. Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск».
  2. Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
  3. В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее».
  4. Убедиться, что в окне открылось приложение Oracle Discoverer Plus.

В случае если приложение Oracle Discoverer Plus не запускается, то следует обратиться в службу поддержки.

4. Описание операций

В разделе «Описание операций» указывают:

  1. описание всех выполняемых функций, задач, комплексов задач, процедур;
  2. описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.

Для каждой операции обработки данных указывают:

  1. наименование;
  2. условия, при соблюдении которых возможно выполнение операции;
  3. подготовительные действия;
  4. основные действия в требуемой последовательности;
  5. заключительные действия;
  6. ресурсы, расходуемые на операцию.

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

4.1. Выполняемые функции и задачи

Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

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

4.2. Описание операций технологического процесса обработки данных, необходимых для выполнения задач

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

Задача: «Визуализация отчетности»

Операция 1: Регистрация на портале ИАС КХД

Условия, при соблюдении которых возможно выполнение операции:

  1. Компьютер пользователя подключен к корпоративной сети.
  2. Портал ИАС КХД доступен.
  3. ИАС КХД функционирует в штатном режиме.

Подготовительные действия:

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

Основные действия в требуемой последовательности:

  1. На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
  2. В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».

Заключительные действия:

Не требуются.

Ресурсы, расходуемые на операцию:

15-30 секунд.

Операция 2: Выбор отчета

Условия, при соблюдении которых возможно выполнение операции:

Успешная регистрация на Портале ИАС КХД.

Подготовительные действия:

Не требуются.

Основные действия в требуемой последовательности:

1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».

РД 50-34.698-90 Руководство пользователя (пример формирования). Oracle Discoverer

2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:

РД 50-34.698-90 Руководство пользователя (пример формирования). Oracle Discoverer

Заключительные действия:

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

Ресурсы, расходуемые на операцию:

15 секунд.

Задача: «Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

5. Аварийные ситуации

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.

Класс ошибки Ошибка Описание ошибки Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД Сервер не найден. Невозможно отобразить страницу Возможны проблемы с сетью или с доступом к порталу ИАС КХД. Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД.
Ошибка: Требуется ввести действительное имя пользователя При регистрации на портале ИАС КХД не введено имя пользователя. Ввести имя пользователя.
Ошибка: Требуется ввести пароль для регистрации При регистрации на портале ИАС КХД не введен пароль. Ввести пароль.
Ошибка: Сбой аутентификации. Повторите попытку Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована. Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД.
Сбой в электропитании рабочей станции Нет электропитания рабочей станции или произошел сбой в электропитании. Рабочая станция выключилась или перезагрузилась. Перезагрузить рабочую станцию.
Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды:
— нажать кнопку «Пуск»
— выбрать пункт «Выполнить»
— в строке ввода набрать команду telnet ias_dwh.ru 80
— если открылось окно Telnet, значит соединение возможно.
Повторить попытку подключения (входа) в ИАС КХД
Сбой локальной сети Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД Перезагрузить рабочую станцию.
Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды:
— нажать кнопку «Пуск»
— выбрать пункт «Выполнить»
— в строке ввода набрать команду telnet ias_dwh.ru 80
— если открылось окно Telnet, значит соединение возможно.
После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД.

6. Рекомендации по освоению

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

Рекомендуемая литература:

  • Oracle® Business Intelligence Discoverer Viewer User’s Guide
  • Oracle® Business Intelligence Discoverer Plus User’s Guide

Рекомендуемые курсы обучения:

  • Discoverer 10g: Создание запросов и отчетов

В качестве контрольного примера рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в п. 4.2. настоящего документа.

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

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

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

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

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

Пример:

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

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

Пример:

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

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

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

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

Как написать понятную инструкцию Как написать понятную инструкцию

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

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

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

Как написать понятную инструкцию

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

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

Подробнее

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

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

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

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

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

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

Структура

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

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

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

Как написать понятную инструкцию

Спасибо!

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

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

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

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

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

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

Примеры:

Плохо

Хорошо

Для этого необходимо перейти в режим записи видео.

Перейдите в режим записи видео.

Ламинированное покрытие нужно протирать обычными моющими средствами.

Протирайте ламинированное покрытие обычными моющими средствами.

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

Смазывайте фурнитуру не реже 1 раза в год машинным маслом для получения легкого хода.

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

Примеры:

Плохо

Хорошо

Эта надпись говорит о вероятной поломке механизма.

Эта надпись говорит о поломке механизма.

Сбор данных скорее всего займет 10 минут.

Сбор данных займет 10 минут.

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

Примеры:

Плохо

Хорошо

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

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

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

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

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

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

Примеры:

Плохо

Хорошо

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

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

Плохо

Хорошо

Номинальная мощность микроволновки – 700 Вт.

Номинальная мощность микроволновой печи – 700 Вт.

Граната автомобиля передает крутящий момент на ось колеса.

Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса.

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

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

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

С засечками

Без засечек

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

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

Иллюстрации

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

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

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

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

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

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

Реклама: 2Vtzqxi7Yrq


Читайте также: Как сделать лонгрид

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

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

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

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

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

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

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

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

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

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

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

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

1. Выбор темы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Как сделать структуру пошагового руководства

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

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

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

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

Как составить инструкцию для сайта

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

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

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

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

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

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

Читайте также: Как сделать анонс статьи, чтобы привлечь читателей

Заключение

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

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

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

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

Журавлев Денис

Что такое руководство пользователя и для чего его создавать

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

Каждый программный продукт нуждается в руководстве пользователя

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

Общие советы по созданию пользовательской документации

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

После этого важно подумать о том:

  • Где пользователь будет к нему обращаться: дома, на работе, в машине?
  • Как часто он будет его просматривать?
  • Насколько объективно сложен для понимания продукт?

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

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

Структура руководства пользователя

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

В первом разделе желательно рассказать общую информацию о программе:

  • Для чего создан продукт.
  • Какие задачи он решает.
  • Какие основные выгоды от использования для клиента.

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

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

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

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

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

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

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

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

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.  

Экспорт руководства пользователя в различные форматы

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

Структура разделов руководства пользователя

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.

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

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Создание руководства пользователя по ГОСТ 34 и ГОСТ 19

Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.

Аннотирование скриншотов пользовательского интерфейса в руководстве пользователя

Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами.  По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.  

Многопользовательская работа над проектом

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

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

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Руководство пользователя к программе Вега Матрица

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке


Наталья Обухова

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

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

Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert


Николай Вальковец

Николай Вальковец, разработчик компании 2V

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

Руководство к программе 2V Стоматология

Прочитать кейс компании V2  


Подытожим

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

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

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

Понравилась статья? Поделить с друзьями:
  • Lebel materia grey инструкция по окрашиванию
  • Biolectra magnesium 400 инструкция на русском языке
  • Как создать аккаунт на телефоне андроид пошаговая инструкция по применению
  • Adamex massimo 3 в 1 инструкция
  • Демотивирующий стиль руководств