Чтобы объяснить человеку как выполнять задачу или работать с инструментом, нужно составить понятную инструкцию. Неизвестная компьютерная программа или новые функции на работе – все это требует разъяснений для успешного взаимодействия. В статье рассмотрим, как правильно написать инструкцию.
Инструкция – это документ, который объясняет способы или правила выполнения определенных действий. А понятная инструкция делает то же самое, но простым языком. Многие руководства написаны очень сложно и люди предпочитают не заглядывать в них, пока что-то не сломается.
Однако такой подход может привести к не самым лучшим последствиям. Например, работник не изучил правила по работе на буровой установке или неверно понял описанный материал, и получил травму из-за неправильного использования техники. Поэтому важно ответственно подойти к составлению и разобраться, как правильно написать инструкцию.
3 основных вида инструкций
Есть несколько типов инструкций. Они предназначены для разных целей, но разрабатываются по схожим принципам. К примеру – уяснив, как написать инструкцию по работе системного администратора, вы легко сможете применить эти знания и при подготовке руководства по использованию мини-АТС.
Пошаговая инструкция
Такие руководства позволяют регламентировать все возможные повторяющиеся процессы. Поставленная задача разбивается на несколько этапов, и каждый этап дополняется пояснениями. Примеры таких инструкций – пошаговые алгоритмы составления бухгалтерской отчетности, подключение к удаленному рабочему столу или действия при пожаре.
Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:
- Откройте верхнюю крышку и извлеките блок фотобарабана
- Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
- Вытащите тонер-картридж
- Поставьте на его место новый
- Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
- Установите фотобарабан обратно в принтер
- Закройте крышку
- Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает – обратитесь к системному администратору
Инструкция по использованию
Это перечень рекомендаций по правильному использованию приборов, например, руководство к сканеру штрих-кодов. Такие мануалы будут полезны пользователям непростых устройств — на рабочем месте или в быту.
В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:
- В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic – 160-180°C.
- Максимальное время работы ламинатора – 4 часа. Затем нужно сделать получасовой перерыв.
- Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его.
- Внимание! Не ламинируйте влажные образцы – жидкость может повредить электронные компоненты!
- После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством.
- Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию!
Должностная инструкция
Так называют документ, регулирующий сферу обязанностей для конкретной должности. Также здесь определены права работника, требования к квалификации, область ответственности и формы премирования. Должностные инструкции могут быть составлены для любого сотрудника – от уборщицы до генерального директора. Их готовят совместно с юристом.
Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:
- Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
- При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
- Бригадир раздает списки, по которым комплектуются грузы.
- Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
- Если есть необходимость, грузчик может привлекаться к другим работам на территории склада – уборке, контролю за въездом транспорта и пр.
Должностная инструкция – это скорее юридический документ, чем пользовательский. А чтобы понятным языком проинструктировать сотрудника по его работе, обычно составляют отдельное обучение – «Пособие по должности». В нем подробно рассказывают о роли и ценном конечном продукте, описывают систему мотивации, метрики и алгоритмы выполнения работы. И размещают эти материалы на платформе для онлайн-обучения.
Ниже вы можете получить готовую структуру обучения для курса «Пособие по должности».
Общие правила при подготовке инструкций
Для подготовки любого типа руководств используются одни и те же приемы работы с информацией. Вот рекомендации, которые подскажут как написать хорошую инструкцию:
- Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
- Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
- Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
- Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
Как структурировать много данных → - Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта
Алгоритм разработки руководства: 9 шагов
Рассмотрим, как написать доступную инструкцию для сотрудников на примере описания алгоритма действий. Особенность этого руководства в том, что для него нужно не только перечислить отдельные действия, а установить их в правильной последовательности, чтобы привести читателя к нужному результату. В общем случае необходимо:
- Собрать информацию
- Сгруппировать ее по отдельным этапам
- Изложить последовательность выполнения каждого этапа с учетом уровня подготовки читателя
В качестве примера возьмем ситуацию, когда организация перешла на электронный документооборот. При этом часть сотрудников не умеет работать с программой Microsoft Word и нужно объяснить им, как подготовить заявление о выдаче спецодежды.
Шаг 1. Изучить ситуацию
Конечно, вы не один год используете Word и легко можете подготовить требуемое заявление. Но в данном случае нужно взглянуть на проблему глазами пользователя – человека, который впервые сталкивается с этой программой. Поэтому нужно не опираться на текущие знания по работе в Word, а самостоятельно проделать весь путь заново. С большой вероятностью вы откроете для себя что-то новое – ведь раньше многие операции выполнялись автоматически. Сходу очень трудно вспомнить, как называлась «та кнопка для создания списка» и другие детали.
Шаг 2. Разложить все на отдельные этапы
Задача этого шага – создать предварительный план решения задачи. Такой алгоритм начинается с исходной ситуации и заканчивается достижением результата. В начало каждого пункта поставьте глагол, определяющий ключевое действие этого шага:
- Запустить программу Microsoft Word
- Создать новый документ
- Набрать необходимый текст
- Отформатировать его
- Сохранить файл
- Сообщить в бухгалтерию, что заявление подготовлено
Шаг 3. Описать каждый этап
Здесь нужно конкретизировать каждый шаг, необходимый для достижения поставленной цели. При этом не усложняйте описание. Если действие можно выполнить несколькими способами, опишите только один вариант, максимум два – тогда читатель с меньшей вероятностью запутается.
Не стоит бояться слишком заурядных объяснений – скорее всего найдутся те, кто еще не знает этого, а остальные легко пропустят такое описание. Например, для тех, кто не работал с программой Word, нужно пояснить как создается файл:
2. Нажмите на раздел «Новый документ» в правой части экрана
Если руководство предназначено для новичков, избегайте профессиональной лексики. В нашем примере лучше обойтись без понятий «Интерфейс» и «Строка состояния». Важно понимать, что вы пишете не теоретический учебник для передачи системных знаний, а практическое руководство, по которому человек сможет здесь и сейчас выполнить действия и достичь результата. Если не обойтись без терминов и аббревиатур, поясните их.
Совет. Старайтесь не нагромождать вашу инструкцию ненужными действиями. Например, лишней будет информация о том, какой шрифт использовать для заявления – в большинстве случаев пользователь столкнется с шаблоном Normal, где стоит подходящий Calibri размером 11 пунктов.
Шаг 4. Рассмотреть нестандартные варианты развития ситуации
Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:
3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры
Шаг 5. Подобрать изображения и привести примеры
Если можно проиллюстрировать какую-то операцию – обязательно сделайте это. Для рецептов блюд подойдут снимки каждого шага, а для инструкций по сборке – взрыв-схемы (эскизы, на которых вся конструкция разобрана на детали и они разнесены в разные стороны). А чтобы наглядно показать работу в компьютерной программе, следует подготовить скринкасты или скриншоты с пояснениями.
Шаг 6. Придумать заголовок
Даже если вы написали руководство для внутреннего пользования, а не для публикации в интернете, яркий заголовок привлечет внимание и настроит на выполнение нужной работы. Вот несколько вариантов для нашего примера:
- «Как написать инструкцию по подготовке заявления»
- «6 шагов для подготовки электронного документа»
- «Простой способ написать заявление на компьютере»
- «Подробный алгоритм подготовки документа для безбумажного оборота»
Шаг 7. Оценить промежуточный вариант
В результате должен получиться подобный текст:
Как написать простую инструкцию (образец):
- Запустите программу Microsoft Word
- Нажмите на раздел «Новый документ» в правой части экрана
- Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
- Отформатируйте набранный текст с помощью верхней панели программы Word.
- Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
- Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
- Выделите список спецодежды и примените к нему функцию «Маркированный список»
- Сохраните файл. Для этого:
- Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
- Выберите путь сохранения файла
- В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
- Нажмите кнопку «Сохранить»
- Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено.
Пример объявления, на который можете ориентироваться при подготовке:
Шаг 8. Тестирование
Внимательно проверьте инструкцию на логические ошибки. Желательно, чтобы коллеги или знакомые взглянули на нее со стороны. Еще лучше – когда неопытный человек изучает составленный алгоритм и пытается с его помощью добиться желаемого результата.
Проверьте алгоритм с помощью этих вопросов:
- Понятен ли указанный порядок действий? Да, мы улучшали его в шагах 2-5
- Все ли нюансы учтены? Да, последовательность шагов охватывает всю необходимую процедуру
- Есть ли в алгоритме сложные этапы, которые можно разбить на несколько частей? Нет, все они были скорректированы на предыдущих шагах
- Достигнут ли результат? Будет ли он неизменным при разных условиях использования алгоритма? Да, на выходе мы получаем файл для безбумажного оборота. При правильном следовании приведенной последовательности, результата можно достичь вне зависимости от того, кто составляет заявление – грузчик или уборщица
Шаг 9. Обучить сотрудников по инструкции
Если руководство предназначено для сотрудников компании, важно проконтролировать, что они изучили ее. Для этого загрузите инструкцию для персонала на платформу Unicraft, назначьте на нее работника и отслеживайте его прогресс.
Особенности такого обучения:
- Информация сопровождается рисунками, схемами, анимацией, формами обратной связи – это увлекательнее, чем простое чтение текста
- В режиме реального времени руководитель может видеть, какое количество материала уже изучено
- В конце разделов и всего курса предусмотрены контрольные вопросы. Процент правильных ответов для успешного прохождения курса можно задавать самостоятельно (обычно он составляет 80%)
Примеры готовых инструкций
Ниже приведены примеры инструкций по пользованию платформой Unicraft. Нажмите на изображение, чтобы перейти на страницу с руководством.
Вывод
Резюмируя все изложенное, можно составить требования к идеальной инструкции:
- Актуальность. В тексте нет устаревших сведений
- Информативность и целостность. Подготовленное руководство содержит все необходимые сведения
по обозначенной теме. У пользователя не остается вопросов - Лаконичность. Приоритеты для составителя – это точность формулировок и отсутствие второстепенных сведений. Часто бывает, что инструкцию смотрят в сложных ситуациях, когда нужно быстро получить ответ на возникший вопрос
- Наглядность. Информация сопровождается примерами и иллюстрациями
- Конкретный результат. Руководство помогает получить конечное решение
- Соотносимость с текущими знаниями пользователя. Чем ниже уровень знаний аудитории, тем подробнее объяснения
- В тексте нет сложных конструкций. Они разбиты на несколько частей. Каждый пункт списка – это отдельное действие, которое дополняется комментариями и пояснениями
Вам будет интересно
Как создать онлайн тест: подробное руководство
План обучения менеджера по продажам
Оценка эффективности обучения персонала: проверенный алгоритм
Перейти на главную блога
Руководство — отличный пример эффективного контент-маркетинга. Гайды не только демонстрируют знания эксперта, но и приносят пользу людям. Сегодня расскажем о том, как их правильно писать.
Итак, начнем с того, что условно гайды делятся на два типа:
- Полное руководство, в котором рассказывается о каком-то сервисе или действии. Пример — создание группы во «ВКонтакте» с нуля, инструкция по пользованию линейкой готовых решений IntecUniverse.
- «КАК-руководство» отвечает на конкретный вопрос. Пример — как настроить Google Диск, как почистить серебро, как приготовить лазанью и пр.
Определитесь с ЦА
Первый вопрос — кто будет читать гайд? Руководство для новичков — это одно. Гайд для тех, кто уже умеет что-то делать и хочет прокачать скилл, — совсем другое.
Разница в подаче материала. Новичкам нужно все разложить по полочкам, подробно рассказать о каждом шаге, чтобы в конце у читателя не осталось вопросов. В руководстве для специалистов можно не рассказывать об очевидном. Например, интернет-маркетологи знают, в чем разница между CTR и CTA, поэтому им объяснять эти термины не надо.
Инструкции со множеством подробностей делают руководство объемным и громоздким. Новичкам, которые хотят вникнуть, придется окунуться в текст. Специалисты же не станут тратить время на давно известную информацию и поищут более лаконичный гайд.
Отжимайте лишнюю воду
Вода вредит любому тексту, а руководству особенно. У современного человека нет времени искать нужную информацию среди «в настоящий момент» и «каждому известно». Писать надо кратко и по делу.
Вот пример неудачного вступления:
У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.
Надо вот так:
В гайде я собрал 11 способов, как нарисовать круг в «Фотошопе». Руководство подходит для версии СС 2015 и выше.
Здесь есть вступление и нет воды, все четко и ясно. Чем короче гайд, тем он привлекательнее. При этом содержание должно быть емким, чтобы читатель узнал то, что хочет.
Очень много вступлений, речевых оборотов и т.д.
Кратко или подробно: ищите баланс
Вы уже решили, кто будет читать руководство, а теперь нужно подумать, на каком языке говорить с ЦА.
В гайде для дотеров можно смело пользоваться сленгом. Для этого достаточно почитать форумы, ознакомиться с парочкой видео и разобраться в терминологии.
В гайде о том, как сделать стяжку пола, тоже можно немного покуражиться. Маловероятно, что этот текст интересен трепетным филологическим девам, поэтому пара шуток или крепких словечек понравятся читателю.
Для сравнения:
Такие действия под запретом, иначе вы столкнетесь с непоправимым ущербом и понесете убытки.
И вот так:
Нарушите инструкцию — песец всему.
Звучит немного эпатажно, но доходчиво, и это отличает гайд от тысячи однотипных текстов. Конечно, такую прямоту оценят не все, но протестировать подобные приемы стоит.
Юмор и близость к разговорному стилю «очеловечивают» гайды, и сухая инструкция превращается в живой рассказ. Людям это нравится.
Помните о структуре
«Нет» длинным абзацам. Абзацы больше 6 строк лучше разбивать на две части — так текст читается легче.
Используйте списки. Надо что-то перечислить — делайте список, даже короткий, даже всего из трех пунктов.
Оформлять инструкции тоже нужно как список. Исключение — руководство с пошаговыми иллюстрациями, которые разбивают текст на части.
Чтобы что-то сравнить, создавайте таблицы.
Без картинок никуда
Руководство без иллюстраций — это не руководство. Его даже не попытаются понять.
Вместо тысячи слов — картинка. Можно интересно писать, но лучше показывать. Например, вы рассказываете о каком-нибудь устройстве. На правой панели прибора в верхней части с левой стороны есть большая желтая кнопка, которую надо нажать. Что проще: объяснять словами или сделать фото и обвести кнопку кружком? Конечно, сделать фотографию.
Нет фотографий — есть YouTube. Найдите видео по теме, сделайте скриншот нужного кадра. Другой вариант — нарисуйте схему в графическом редакторе. Так, если вы пишете гайд по работе с компьютером, делайте много скриншотов. Удалить лишние скрины проще, чем обнаружить, что не хватает какого-то шага, и начинать все сначала.
Конечно, есть вещи, которые ни фотографиями, ни скриншотами не передать. Если надо объяснить, как правильно приседать или сделать потайной шов, поможет GIF-анимация.
Как тут не вспомнить главреда всея интернета Максима Ильяхова, который делает гифку из редактирования текста. Вот абзац, вот удаление лишнего, вот результат. Круто? Круто.
При желании можно создать видеогайд — альтернативу текстовому руководству. Кто любит читать инструкции, тот пусть читает, а кто предпочитает смотреть — пусть смотрит.
Не забудьте закончить руководство фотографией результата. Это важно для гайдов по готовке или рукоделию. Если стейк получился похожим на подошву, читатель вряд ли захочет повторить такой опыт.
Ссылки
Еще раз: гайд должен быть лаконичным. Это не перечисление всех терминов и определений. Однако информативность не должна страдать, поэтому используйте ссылки.
Особенно полезны ссылки на сайтах с разными руководствами. Перед автором задача — написать серию текстов о командной строке в Linux. Писать, как открывать строку в каждом гайде, — потеря времени. Можно вынести инструкцию в отдельный мини-гайд и на каждой странице добавлять ссылку на него. Красивое решение как с позиции SEO, так и с точки зрения юзабилити.
Этот рецепт работает и с полными руководствами. Не размещайте огромное текстовое полотно на одной странице, а разбивайте его на разделы с грамотной перелинковкой. Google и Яндекс именно так и устроили гайды для своих сервисов.
Заключение
Контент в виде хорошего гайда работает — доказано практикой. Грамотное руководство с большой вероятностью окажется в ТОПе поисковых систем. Пользователи будут добавлять его в закладки, делать репосты, отправлять ссылки коллегам.
С помощью качественного гайда вы увеличите посещаемость сайта. А если напишете классное руководство для клиента, то он к вам обязательно вернется.
Писать руководство пользователя по шаблону. Удобно? Удобно
Время на прочтение
4 мин
Количество просмотров 6.8K
Команда, разрабатывающая софт для создания пользовательской документации, делится лайфхаками на тему написания идеальной пользовательской документации для тех, кто далёк от написания руководств к программе.
Для чего мы сами конструируем некоммерческие образцы документации и инструкций для пользователей
Наш проект существует и развивается уже долгое время, практически шестнадцать лет, если быть точнее. За этот срок была сформирована определенная база, где собраны самые актуальные и насущные вопросы, которые возникают перед людьми, создающими справочные элементы к своему проекту.
Ведя диалог с нашими клиентами, мы смогли выделить их потребности и понять основную «боль». Если обобщить, основная проблема заключалась в том, что ни одна программа для создания файл-справок и инструкций не могла выполнить самую нудную, энергозатратную часть проекта — само разрабатывание и оформление этой пользовательской документации
Даже имея осознание того, что файл-справка — неотъемлемый и действительно полезный элемент для пользователя, очень редко возникает мотивация оформить его грамотно и качественно. Еще реже желание возникает, когда в написании пользовательской документации нет опыта или специалистов, которые бы этот опыт имели. Обычно, эта обязанность с легкой руки падает на плечи самих создателей программы, людей, занимающихся тестированием, аналитикой, специалистам поддержки или даже руководителей компании, которые тоже не совсем понимают, как грамотно создать что-то подобное.
Отсюда вытекает еще одна загвоздка. Люди, у которых нет опыта и в принципе понимания, как начать и что туда вносить, просто не знают, как создать качественное руководство для пользователей. В таких случаях большинство следует привычному пути: загуглить определение и найти готовый шаблон.
И с какой-то стороны, это разумно. Мы достаточно часто сталкиваемся с такими запросами, пользователи просят у нас пошаговое руководство или хотя бы костяк готовой инструкции.
Так вышло, что потребности наших клиентов практически на сто процентов входят в нашу экспертную сферу. И мы приняли решение по возможности помочь всем, кто хочет (или вынужден) заниматься созданием файл-справок и инструкций к своему продукту и предоставить возможность получить образцы, которые могут послужить базой и легко быть адаптированными под конкретный запрос.
В связи с этим, мы сами создали готовые образцы и костяки шаблонных проектов в программе. Что входит в нашу базу:
-
Руководство пользователя программного обеспечения.
-
Руководство пользователя web-сервиса.
-
Корпоративная база знаний компании.
В чем удобство создания руководства пользователя по образцу
Вы бережете своё время.
Адаптируя уже созданный образец под свой продукт, вы не тратите время на создание основы с нуля, вам не нужно тратить время, чтобы найти мастер-класс о том, как правильно это сделать. Используя готовый шаблон документации, вы значительно экономите время на создание структуры проекта с нуля и на поиск и изучение информации о том, как это делается.
Вы сосредотачиваете внимание на вашей программе, а не на создании файл-справки
В шаблоне уже есть текстовые и графические вставки, вы можете сами добавлять нужный контент в предложенные места и не продумывать вариант оформления.
Наглядность.
Все образцы и костяки инструкций для пользователя изначально настроенные с динамическими стилями оформления, которые помогут вам быстрее освоиться и разобраться, как можно использовать это для быстрого выполнения своей цели.
Адаптация шаблонов и образцов под ваш проект.
Всё, что находится в шаблонах, можно назвать нашим советом, который был создан на основе многолетнего опыта в данной сфере и выработанной экспертностью. Абсолютно всё в этих шаблонах может быть подвержено адаптации, так как для пользовательской документации нет жестких стандартов, она должна быть выстроена персонально под ваш продукт.
О шаблонах
За 15 лет мы смогли подвергнуть аналитике более сотни разных файл-справок, инструкций и технических документаций, что дало нам возможность сделать вывод и определить шаблонные разделы, которые могут быть применены к огромному количеству программ, после чего мы интегрировали их в наши образцы. Давайте немного подробнее поговорим о структуре.
Обзор возможностей программ. Здесь идет краткое содержание сути вашего продукта. Где вы рассказываете о том, для чего нужна ваша программа. Какие боли и потребности она удовлетворяет, на что способна.
Пользовательский интерфейс. Здесь вы можете наглядно показать вашему клиенту интерфейс, ознакомить его со всеми режимами, дополнительными кнопками и.т.д. Если пользователь может персонализировать интерфейс под себя, об этом тоже лучше указать именно в этом разделе.
Типовые задачи. Здесь нужно максимально подробно познакомить пользователя со всеми основными возможностями программы и детально описать ряд задач и вопросов, которые клиент сможет решить с её помощью. В нашем образце этот блок сформирован из двух подразделов. В подразделе «Примеры использования» лучше всего рассказать пользователю, как ваш продукт будет решать его вопросы и задачи. Если обобщить, то в этом подразделе вы рассказываете про клишированные проблемы, с которыми сталкивается большинство пользователей. В подразделе «Лучшие практики» лучше разместить максимально полезную информацию о том, как упростить свою работу в программе и как пользоваться ей максимально эффективно.
Особые случаи. Здесь нужно рассказать пользователю про то, какие трудности могут возникнуть и как их решить, выделить часто задаваемые вопросы и дать на них самый доступный ответ. Подразделы: «FAQ» и «Устранение типовых проблем»
Вспомогательная и юридическая информация. Здесь вы размещаете информацию о компании, размещаете контактные данные тех.поддержки, информацию о сотрудничестве, сайт, а также лицензионные соглашения.
Названия проекта публиковать не будем, Хабр ругается.
P.S. Мы будем рады, если наши образцы помогут вам закрыть вопрос и успешно реализовать документацию в своем проекте.
Загрузить PDF
Загрузить PDF
На первый взгляд, написать руководство — дело сложное. На второй взгляд все, как ни странно, куда проще. Прочитайте эту статью и узнаете, как написать любую инструкцию, от простой до сложной!
-
1
И в этом вся соль. Да, звучит очевидно, но знание — ключ к успешному написанию руководства. Вы должны знать предмет если не во всех-всех, то хотя бы во многих тонкостях. Чем лучше и глубже вы знаете предмет, тем проще вам будет объяснить незнакомому с ним человеку что угодно.
-
2
Проконсультируйтесь с экспертами. Если ваша задача — просто написать, а не выступить в качестве эксперта, то и писать придется “под диктовку”, сверяясь с экспертами и давая им проверить написанное. Знание и советы от знающих людей бесценны.
-
3
Используйте практический подход. Попробуйте и сами сделать то, о чем пишете, и вы поймете, о чем захочется узнать вашему читателю и что выяснить.
-
4
Почитайте больше тематических источников. Прочтите то, что уже написано по теме вашего руководства — это будет только на пользу.
- Аналогичные руководства помогут понять, о чем и как надо писать.
- Анализируйте прочитанное, ищите общие черты к описанию особенностей и функционала.
- По аналогии поступайте с различиями. Так вы сумеете описать уникальные функции своего товара или продукта. Чем больше информации в руководстве, тем лучше и тем больше вероятность, что читатель будет заинтересован ею и дочитает ее до конца.
- Читайте тематические журналы. Узнайте, как пользуются тем или иным инструментом люди, которым он необходим в повседневной практике. Может, исходя из этого следует уделить больше внимания какой-нибудь особенности вашего продукта.
Реклама
- Аналогичные руководства помогут понять, о чем и как надо писать.
-
1
Разложите все по пунктам. Прежде чем писать любое руководство, каким бы оно ни было, надо составить его план.
- Польза понятна — можно уделить внимание всем нужным аспектам. А ведь ваша цель состоит как раз в том, чтобы познакомить пользователя с процессом — пусть даже и в общих чертах. А то, как выполняется какое-нибудь конкретное действие, можно перенести в конец руководства, или же и вовсе не упоминать.
-
2
Соблюдайте логическую последовательность. Этот совет особенно полезен, если вы сами не очень хорошо разбираетесь в теме. Сами посудите, говорить о вспышке фотокамеры стоит уже после того, как вы объясните, как вставить линзы, зарядить пленку, настроить фокус и все такое.
-
3
Возьмите этот шаблон за основу содержания руководства.
-
4
Прочитайте все и проверьте. Убедитесь, что ничто не отходит от выбранной вами схемы повествования.
-
5
Возьмите то, к чему пишете руководство. Пусть этот предмет будет у вас под рукой — вам нужно будет, проверки ради, воспользоваться им строго по написанному собой руководству.
Реклама
-
1
Напишите введение. Это задаст тон всему руководству и покажет читателю, что его ждет. А то, каким должно быть вступление, зависит от вашего читателя. Понятно, что инструкция о том, как сделать открытку к дню рождения будет слегка отличаться от “инструкции” по проведению операции на открытом сердце. Выберите стиль повествования и не отходите от него.
-
2
Выполните все действия, параллельно записывая все. Так не только будет честно, но еще и вы сами ничего не пропустите.
- Если такой возможности нет, то обязательно проконсультируйтесь в конце с экспертом.
-
3
Пронумеруйте действия. С нумерованным списком людям работать проще, это факт.
- Если вы пишете на бумаге, оставляйте между строчками достаточно места, чтобы выставить еще линию-другую. И не забудьте сдвинуть нумерацию, если что.
-
4
Напишите советы и предупреждения. В процессе работы над руководством вас может посетить мысль о том, что без должной тщательности выполнение того или иного действия пользователем может привести к проблеме.
- Плюс если у вас есть в памяти интересный факт, которым будет полезно поделиться с читателем — напишите и его.
-
5
Проверьте все. Итак, у вас есть инструкция — теперь сделайте нужное действие строго по вашему руководству. Если вы найдете места, где ваше руководство непонятно, неадекватно, неточно и т.д. — исправьте все как надо. Повторяйте этот этап до тех пор, пока ваше руководство не станет полным.
- Полезно будет дать почитать руководству другу и посмотреть, поможет ли оно им. Следите за их реакцией и затем внесите в руководство нужные изменения.
-
6
Отредактируйте руководство. Проверьте грамматику, орфографию, пунктуацию. Вы же не хотите сдать работу с ошибками?
Реклама
-
1
Начните с верхнего уровня. А верхний уровень — это заголовки. Закончив все выше перечисленные пункты, перечитайте руководство и найдите в нем будущие заголовки будущих разделов.
- Дайте им название и запомните, на какой они строке находятся.
-
2
Если нужно, сделайте содержание. Сгодится обычное иерархическое содержание, то есть главная страница и несколько подзаголовков с субкатегориями и так далее. Чем более проработанное и подробное руководство вы написали, тем больше разделов и подразделов вам понадобится.
-
3
Отредактируйте все еще раз. Да, именно. Еще раз. Во второй раз вы, вне всякого сомнения, увидите те ошибки, которые пропустили в первый раз.
- В случае более подробного руководства это также даст вам возможность выделить небольшие темы и внести их в содержание.
Реклама
Советы
- По возможности, иллюстрируйте свое руководство. Если изображения вставлять нельзя, делайте отсылки к распространенным примерам.
- Если есть возможность, дайте новичку попользоваться устройством, а потом запишите все заданные им вопросы. Это поможет сделать руководство полезнее и полнее.
- Даже если что-то кажется вам очевидным, об этом все равно надо писать. Лучше написать больше, чем меньше.
- Если вы пишите очень подробное руководство, где нужно написать целые главы — то начните с оглавления. И помните, что к главам применимы те же самые базовые требования, ибо что такое глава, как не мини-руководство?
- Каждый раздел пишите на отдельной странице, так будет проще их, если что, поменять местами, внести исправления и так далее. На компьютере это особенно просто.
Реклама
Об этой статье
Эту страницу просматривали 9239 раз.
Была ли эта статья полезной?
Download Article
Download Article
A how-to guide is an informative piece of writing instructs a reader on performing a task by giving step-by-step instructions. It is a practical way to convey information about an active process. Creating a how-to guide can be an opportunity to share a practical skill you possess with a wider audience.
-
1
Think about your target audience.[1]
You should consider a specific audience when you begin your how-to guide. The audience will determine the level of detail you need to provide as the breadth of information you should cover.- A how-to guide for making a mango mojito directed at bartenders would differ greatly from the same how-to guide written for people without bartending experience who wish to make a mango mojito at home. The layperson’s guide would likely be more detailed without using any beverage service “slang.”
-
2
Familiarize yourself with the process you’re writing about. Before you write, you should be able to do the process yourself several times. Even if it is something you have done repeatedly, try doing it again, thinking mindfully about each step you take as you go through the process.
- If you pour yourself a mango mojito at the end of every day, you likely don’t have to think about the proper ratios, and you may take parts of the process for granted (like getting out a glass and filling it with ice).
Advertisement
-
3
Research the process. Your own experience can be a great basis for a how-to article, but it never hurts to supplement your experience with research.[2]
Try searching for the topic online and see how others do what you do. You may want to integrate others’ approaches into your guide by suggesting alternate approaches. Be sure to credit any sources that you draw from directly.- If you have a signature mango mojito recipe, your how-to article can only be improved by searching for other recipes for the same drink. You may find a shortcut, an alternate ingredient, or an aesthetically pleasing garnish you never considered.
-
4
Gather materials needed to create your guide. Before writing, collect the material and information you wish to include in your guide.[3]
This may mean photographing the process at each step or creating flowcharts or graphs that complement your written material.- For your mango mojito guide, you might want to photograph the ingredients before you begin, then take action shots of each part of the mojito creation process. You may even want to recruit another person to take the pictures.
Advertisement
-
1
Establish the sequence. The main sequence of events is the most important part of a how-to guide.[4]
The order of the steps is very important since the nature of the guide is a step-by-step approach. You should choose one if there is more than one possible order for some of the steps. You could note that some of the steps are interchangeable, but it’s best to commit to a particular order.- Your sequence for making a mango mojito could be gathering the ingredients, muddling the mint and mango, pouring the liquor and club soda into a mixer, mixing the ingredients, placing ice in a glass, placing the muddled mint and mango on top of the ice, pouring the liquids over the ice and fruit, then garnishing the drink, and serving the drink.
- The sequence is important; obviously, you can’t serve the drink before you make it. An example of an optional item placement in the sequence is when to place the ice in the glass: it could be done before you start mixing the drink.
- Your sequence for making a mango mojito could be gathering the ingredients, muddling the mint and mango, pouring the liquor and club soda into a mixer, mixing the ingredients, placing ice in a glass, placing the muddled mint and mango on top of the ice, pouring the liquids over the ice and fruit, then garnishing the drink, and serving the drink.
-
2
Create clear, active headings. Even if a single step contains detailed information, it should begin with a clear, concise heading. The heading should be directing someone towards an action.[5]
Some people may skim your guide, or rely primarily on the headings to guide them, reading the subtext only if they are confused about how to implement a step.- For example, a heading for a step in your mojito making may be “Muddle the mint and mango.” Someone who knows how to muddle may read the step heading and do the step without reading the instructions that accompany the step. The heading is clear and precise.
-
3
Use explanatory text and bullet points when necessary. Beneath your clear headings, you should provide adequate (but not overwhelming) additional information.[6]
If your information for completing a step exceeds 4 or 5 bullet points or sentences, you might want to break the step into two steps. You can always use “part one” and “part two” if a single heading is necessary for both steps.- Consider using bullet points to break up information. This is often more accessible than a paragraph of block text.[7]
- The text beneath the heading “Muddle the mint and mango” may be:
- Use a mortar and pestle to crush the mint leaves and mango chunks.
- If you do not have a mortar and pestle, use a small bowl and the back of a wooden spoon.
- Consider using bullet points to break up information. This is often more accessible than a paragraph of block text.[7]
-
4
Write in an active, clear style. Particularly if you are writing for laypeople (not experts in the field in which you are writing), you should write clearly and use short, active sentences. Aim for a 7th or 8th-grade reading level.
-
5
Use graphics to support your text. A how-to guide almost always benefits from graphics.[8]
The level of graphics that you can use may be limited by the publication medium (if you are creating a print publication, for example, you may be limited to black and white line graphics). Graphics should be high-quality and show exactly what happens in each step.- Be sure you have permission to use and publish any graphics you did not create yourself.
- If you are writing a how-to guide for a technical process on a computer, you may want to take screenshots to demonstrate what you are saying.
- For making a mojito, photographs of the drink evolving with each step would be helpful to most readers.
-
6
Edit graphics or screenshots to highlight key information. Use a graphic editing program to draw arrows to or circles around portions of your graphic to direct the audience’s attention to what you want to show them.
- For example, if you have provided a photograph of all of the ingredients of your mojito with the step “Select a quality rum,” you may want to add an arrow on top of the graphic that indicates the bottle of rum in your photo.
Advertisement
-
1
Proofread your writing. As with any writing, check carefully for spelling and grammar mistakes. You should also be sure that your writing is clear and simple. Having someone else proofread for you or read your steps in reverse can be helpful. Reading in reverse can make your writing seem new and prevent you from “seeing” what you meant to say instead of what you have said.[9]
-
2
Test the guide for accuracy. Before you distribute your how-to guide, follow it yourself. Pretend you are doing something for the first time and follow your step-by-step instructions. You may have omitted an obvious step or written something out of order. If possible, have someone else follow the guide and give you feedback about how easy it is.
- Make yourself that mango mojito; you deserve it! Be sure you are making it from the steps in the guide, though, and not your memory of how you’ve made it in the past.
-
3
Publish the guide. Once you have perfected your guide, publish it in an appropriate venue.[10]
This may mean putting it on your blog, submitting it to a website that curates guest posts, or submitting it to a print publication. Whatever the venue, ensure your writing meets any specified guidelines for length, image quality, or other considerations.
Advertisement
Ask a Question
200 characters left
Include your email address to get a message when this question is answered.
Submit
Advertisement
Thanks for submitting a tip for review!
References
About This Article
Thanks to all authors for creating a page that has been read 81,037 times.