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

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

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

Инструкция

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

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

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

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

Время от времени в своей работе консультантов мы сталкиваемся с ситуацией, когда Заказчик говорит нам: "…Вы ведь написали уже много должностных инструкций для разных компаний. Они у Вас, наверняка, остались. Продайте мне готовые инструкции для…". Мы в ответ начинаем объяснять, что должностные инструкции - дело индивидуальное для каждой компании. Заказчик удивляется: "Почему индивидуальное? Ведь продавец, водитель, кладовщик (нужное - подчеркнуть) - он и в Африке продавец, водитель, кладовщик… Есть же типовые должностные инструкции…".

Давайте разберемся

Еще один пример из нашей практики. Однажды после корпоративного тренинга в одной торговой компании ее руководитель сказала нам: "Я думала, что они (мой персонал) делают то, что я думаю. А они делают то, что сами думают, и полагают, что делают то, что я думаю". Иными словами, персонал компании делал продажи, объем которых устраивал руководство. На тренинге же вскрылось, что персонал не уделял внимания выстраиванию долговременных отношений с фирмами-покупателями, в то время как руководитель компании считала эту работу важной и полагала, что она выполняется. Ситуацию исправили следующим образом: изменили должностные инструкции специалистов отдела послепродажного сопровождения, в которых указали когда, что и как делать в плане развития отношений с клиентом для получения нужного результата. Как Вы думаете, подойдут ли эти инструкции Вашей компании? Не факт. А согласится ли владелец "выстраданных" работающих должностных инструкций опубликовать их, если там содержится его "ноу-хау"?

Снова здравствуй, уважаемый хабралюд!

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

Всем, кому интересно, прошу под хабракат.

KISS

Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.

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

1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4. Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5. Психологический момент - инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому - НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!

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

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

Clear screen/clear desk

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

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

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

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

Предназначение должностной инструкции:

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

Что нужно знать о должностных инструкциях:

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

Основные пункты должностной инструкции:

1. Общие положения: назначение документа, категория должности, порядок приема на работу, кому подчинятся сотрудник, требования к образованию и профессиональным навыкам.
2. Описание должностных обязанностей: ежедневных, еженедельных, ежемесячных.
3. Права сотрудника. В отличие от трудового договора, тут указываются права, вытекающие из функций структурного подразделения и организации. Например, участие в проектах и разработках, принятие решений в соответствии с полномочиями, обучение и повышение квалификации.
4. Список документов, которыми должен руководствоваться сотрудник: приказы, инструкции, нормативные акты.
5. Порядок взаимодействия с другими сотрудниками. Указывается основной круг лиц, порядок подчиненности или руководства, сроки и регламент предоставления информации и ответов на запросы.
6. Ответственность сотрудника. При указании мер ответственности обязательна ссылка на соответствующий нормативный акт (ГК, ТК или УК).
7. Порядок оценки работы. Указываются критерии оценки качеств сотрудника (компетентность, инициативность, профессиональная грамотность) и работы (результаты, качество и своевременность выполнения). Также прописывается мотивационная составляющая (подарки, премии, поощрения) и наказание за невыполнение (штрафы, выговоры).
8. Заключительная часть: дата вступления в силу, подписи.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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