Вам понадобится

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

Инструкция

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

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

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

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

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

Общие правила

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

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

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

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

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

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

Заключительные положения (порядок внесения изменений в документ, дата, с которой должностная инструкция вступает в силу).

Технологическая инструкция

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

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

Инструкция по эксплуатации

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

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

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

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

Шаги

Часть 1

Подготовка к написанию инструкции

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

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

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

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

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

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

   • В определениях или объяснениях старайтесь использовать краткие конструкции.
   • Например, скажите «Добавьте два яйца» вместо «В тесто для торта следует добавить два яйца».

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

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

4. Используйте обращения. Текст инструкции следует составлять как разговор с читателем. Для этого используйте слово «вы». С ним вы лично проведете читателя через все пункты.

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

   • Приводите точные величины. Если кому-то нужно отрезать 7,8 см от доски, так и говорите.
   • Например, при составлении кулинарного рецепта не ждите до четвертого этапа, чтобы сказать: «Перед тем как смешивать ингредиенты, просейте муку и нагрейте яйца до комнатной температуры.»

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

   • Некоторые вводные слова: во-первых, далее, затем, наконец, после, прежде.

Часть 3

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

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

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

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

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

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

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

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

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

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

Вот здесь и начинается все самое интересное…

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

Удобство и простота использования товара всегда являлись весомыми «рычагами» влияния на принятие ЦА решения о покупке.

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

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

Написание качественного руководства по эксплуатации товара - это целое искусство. Давайте приоткроем занавес и заглянем «за кулисы» его создания.

Итак, на что же стоит обратить внимание при составлении руководства по эксплуатации, которое будет «работать» на продажи?

Детализация

Конкретика и степень детализации - те параметры, которые определяются согласно уровню подготовленности ЦА. Здесь выбирается оптимальный баланс, ориентированный на потенциального покупателя.

Например:

После нажатия ____ появляется приветственное окно.

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

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

После нажатия пальцем клавиши ____ в правом верхнем углу клавиатуры на экране появляется приветственное окно с темно-синей надписью «____», расположенной посередине.

Структурирование

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

Сравните:

1. Вставьте диск в дисковод.
2. В появившемся окне нажмите ____.
3. Выберите пункт меню ____.

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

В первом варианте мы видим пошаговое структурирование информации. Четко, легко и понятно. Иначе выглядит и воспринимается второй вариант - он более «тяжеловесный».

Позитив и корректность

Думаете, это не важно? Ошибаетесь! Для позитивного результата нужно мыслить позитивно и говорить позитивно посредством текста с ЦА (да простят нас ярые противники тавтологии).

Никто не любит хамства и унылости. Поэтому настраивайте деликатно и очень корректно потенциальных покупателей ТОЛЬКО на позитив.

Вот как это выглядит на практике:

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

Достаньте монитор из коробки и освободите от упаковки. Постарайтесь в процессе его не уронить и не разбить.

НЕТ трем «С»: сокращениям, синонимам и сомнениям

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

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

Транспортная компания (ТК) отвечает ____.

Многофункциональное устройство (МФУ) работает ____.

Операционная система (ОС) запускается ____.

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

Если речь идет, например, о мобильном телефоне, то не стоит применять по тексту инструкции такие слова, как «мобильник», «мобила», «телефонный аппарат», «сотовый телефон» и т.д.

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

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

Используйте повелительное наклонение - побуждайте пользователей к действию (призывайте, советуйте, предупреждайте, запрещайте).

Сравните:

Для включения телефона нужно нажать на ____.

Кнопка ____ отвечает за включение телефона.

Нажмите ____, чтобы включить телефон.

Включите телефон с помощью кнопки ____.

Последний штрих

Хуже всего, если человек ввиду «путаного руководства» не смог понять, как пользоваться товаром, и отказался от его приобретения. Поэтому…

После того, как готовая инструкция закрепилась на «экранном листе» монитора нажатием кнопки «сохранить», не лишним будет проверить - понятна ли она вашей ЦА.

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

Руководства по использованию, которые стимулируют пользователей к покупке.

Что такое инструкция?

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

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

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

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

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

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

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

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

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

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

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

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

С чего следует начать подготовку инструкции?

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

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

Для чего предназначена эта документация?

Я составляю документацию для отдельного пользователя или для группы пользователей?

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

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

Нужен ли глоссарий?

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

Подходит ли стиль написания для самого низкого уровня потенциальных пользователей?

Следует ли включать предметный указатель?

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

Как следует оформлять официальные внутрифирменные инструкции?

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

УТВЕРЖДАЮ Президент Акционерного общества «Олимп» подпись В.Л. Плотников 30.03.02

УТВЕРЖДЕНО Приказ министра здравоохранения России 15.11.99 № 287

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