Что обычно пишут в руководствах

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

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

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

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

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.

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

Виды руководящих документов 

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

Виды некоторых руководящих документов и их назначение

Что такое руководство и зачем оно нужно? 

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

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

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

Думаю, понятно, что многие из заявленных «непоняток» были очень похожи на простой саботаж, которым иногда не брезгуют работники. Дескать, а где написано, что я должен сначала выдать товар покупателю, а уж потом подметать пол на складе? Я хочу сначала подмести, у меня и в инструкции написано: «удалить из помещения склада использованные упаковочные материалы и тару», и пусть весь мир подождет! Или что я должен сделать вначале: выключить освещение в помещении склада или пойти переодеваться?

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

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

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

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

Структура руководства не регламентирована, но в целом имеет много общего со структурой других руководящих документов – положения, регламента (Схема 1).

Структура руководства

Раздел «Общие положения» 

Обычно в разделе «Общие положения» любого документа указываются:

1. Назначение (цель) документа.

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

3. Нормативные ссылки (или нормативные документы).

4. Связанные документы, локальные нормативные акты.

5. Глоссарий (термины и сокращения).

6. Порядок утверждения руководства, внесения в него изменений и его отмены.

Назначение (цель) документа 

В написании этой части применяется стандартная фраза для всех руководящих документов подобного вида, например:

1.1. Настоящее руководство устанавливает и регулирует общий порядок работы персонала склада.

Также можно использовать такую формулировку:

1.1. Цель настоящего руководства – установление и регулирование общего порядка работы склада.

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

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

1.2. Область применения документа:

– складское хозяйство;

– транспортный отдел.

Нормативные ссылки (или нормативные документы) 

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

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

1.3. Нормативные документы:

1. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по количеству (утв. Постановлением Госарбитража СССР от 15.06.1965 № П-6).

2. Инструкция о порядке приемки продукции производственно-технического назначения и товаров народного потребления по качеству (утв. Постановлением Госарбитража СССР от 25.04.1966 № П-7).

Материал публикуется частично. Полностью его можно прочитать в журнале «Секретарь-референт» № 8, 2021.

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

1. Избегайте помпезности

tip2

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

2. Позвольте немного слабости

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

3. Оно не должно быть идеальным

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

4. Необходимые элементы

Начните с:

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

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

5. Дайте клиенту выбор

Назовите руководство, к примеру, Styleguide_lite_v0.1 и объясните клиенту, что это “упрощенное” (в оригинале) руководство по работе с брендом, которое подходит для повседневного творческого использования. Если они хотят дополнительную и более продуманную версию – это может быть классифицировано как отдельный проект … с отдельным бюджетом.

6. Ищите правильную подачу

tip3

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

7. Руководство не проповедует

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

Не стоит писать руководство в школьном стиле. “Не делай это, не делай то” – это отличный способ уничтожить желание дизайнера нормально использовать руководство.

8. Думайте о нем, как о книге рецептов

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

9. Концентрируйтесь на видимом

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

10. Чем меньше, тем лучше

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

11. Будьте полезными и конкретными

tip6

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

12. Думайте творчески

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

13. Работайте с копирайтером

tip7

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

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

14. Выберите правильный тон

tip18

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

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

15. Корректируйте вашу работу

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

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

16. Демонстрируйте элементы на странице

tip8

Не просто говорите, а делайте.

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

17. Усваивайте оформление и шаблоны

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

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

18. Создавайте наглядные примеры

tip10

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

19. Объясняйте ваш типографский выбор

tip11a

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

Объясняйте ваш выбор и аргументируйте.

tip11b

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

20. Рационализируйте ваши мысли

tip13

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

tip13b

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

21. Постарайтесь предвидеть вопросы

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

Также создавайте FAQ и подумайте о 20 вопросах, которые скорее всего могут задать.

22. Создавайте ощущение путешествия

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

23. Обеспечивайте гибкость

tip19

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

24. Оставьте место для усовершенствования

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

c4guide

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

Автор: Paul Wyatt

Перевод: Say-Hi

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

Тренды в веб-дизайне 2016: советы по использованию цвета

50 новых бесплатных инструментов для веб-дизайна

Почему в дизайне важно рассказать историю


Загрузить PDF


Загрузить PDF

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

  1. Изображение с названием Find a Job if You Have a Disability Step 3

    1

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

  2. Изображение с названием Succeed in Network Marketing Step 16

    2

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

  3. Изображение с названием Become a Petite Model Step 7

    3

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

  4. Изображение с названием Think Like a Graphic Designer Step 12

    4

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

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

    Реклама

  1. Изображение с названием Do Research Step 19

    1

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

    • Польза понятна — можно уделить внимание всем нужным аспектам. А ведь ваша цель состоит как раз в том, чтобы познакомить пользователя с процессом — пусть даже и в общих чертах. А то, как выполняется какое-нибудь конкретное действие, можно перенести в конец руководства, или же и вовсе не упоминать.
  2. Изображение с названием Barter Step 19

    2

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

  3. Изображение с названием Write a Biographical Sketch Step 2

    3

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

  4. Изображение с названием Defend Against Appropriation of Name or Likeness Claims Step 15

    4

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

  5. Изображение с названием Get a Job in Another State Step 11

    5

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

    Реклама

  1. Изображение с названием Apply for an Entrepreneurial Grant Step 8

    1

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

  2. Изображение с названием Connect Headphones to the PS3 Step 19

    2

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

    • Если такой возможности нет, то обязательно проконсультируйтесь в конце с экспертом.
  3. Изображение с названием Make a Computer Operating System Step 1

    3

    Пронумеруйте действия. С нумерованным списком людям работать проще, это факт.

    • Если вы пишете на бумаге, оставляйте между строчками достаточно места, чтобы выставить еще линию-другую. И не забудьте сдвинуть нумерацию, если что.
  4. Изображение с названием Spot Fake News Sites Step 8

    4

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

    • Плюс если у вас есть в памяти интересный факт, которым будет полезно поделиться с читателем — напишите и его.
  5. Изображение с названием Connect Headphones to the PS3 Step 17

    5

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

    • Полезно будет дать почитать руководству другу и посмотреть, поможет ли оно им. Следите за их реакцией и затем внесите в руководство нужные изменения.
  6. Изображение с названием Get a Job Fast Step 1

    6

    Отредактируйте руководство. Проверьте грамматику, орфографию, пунктуацию. Вы же не хотите сдать работу с ошибками?

    Реклама

  1. Изображение с названием Write a Grant Proposal Step 16

    1

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

    • Дайте им название и запомните, на какой они строке находятся.
  2. Изображение с названием Write a Grant Proposal Step 18

    2

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

  3. Изображение с названием Write a Grant Proposal Step 7

    3

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

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

    Реклама

Советы

  • По возможности, иллюстрируйте свое руководство. Если изображения вставлять нельзя, делайте отсылки к распространенным примерам.
  • Если есть возможность, дайте новичку попользоваться устройством, а потом запишите все заданные им вопросы. Это поможет сделать руководство полезнее и полнее.
  • Даже если что-то кажется вам очевидным, об этом все равно надо писать. Лучше написать больше, чем меньше.
  • Если вы пишите очень подробное руководство, где нужно написать целые главы — то начните с оглавления. И помните, что к главам применимы те же самые базовые требования, ибо что такое глава, как не мини-руководство?
  • Каждый раздел пишите на отдельной странице, так будет проще их, если что, поменять местами, внести исправления и так далее. На компьютере это особенно просто.

Реклама

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

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

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

Понравилась статья? Поделить с друзьями:
  • Высшее руководство лаборатории это
  • Остекление лоджии своими руками пошаговая инструкция
  • Инструкция по охране труда периодичность заполнения
  • Новалис таблетки показания к применению инструкция
  • Посудомоечная машина аристон li 480 a инструкция