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

Определите, для кого готовится инструкция.

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

Точно определите, о чем будет сказано в инструкции.

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

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

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

В глоссарии нужно использовать максимально точные описания терминов. Если используется акроним, объясните его значение (например, Scuba – «Self Contained Underwater Breathing Apparatus» автономный аппарат подводного дыхания).

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

Подумайте об организационной структуре каждого раздела.

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

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

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

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

Внесите изменения, чтобы облегчить читателю поиск необходимой информации.
1. Пример 1: (Используйте нумерованный список) В редакторе можно привязать рисунок к пункту 13-му параграфу инструкции.
2. Пример 2: (Сортировка) В редакторе можно увеличить размер текстовой строки, если она выделяется из общего порядка.

Не списывайте чужие инструкции! Используйте указатели и список литературы, указывая, откуда заимствована цитируемая информация (другие авторы, инструкции и т.д.).

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

Добавьте соответствующие иллюстрации. Расположите их в тексте. Не бойтесь оставлять пустое пространство.

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

- Лучший, по нашему мнению, порядок проверки готовой инструкции:
  1. Вычитайте ошибки самостоятельно.
  2. Попросите друга проверить ошибки.
  3. Дайте работу на проверку специалисту в данной области, чтобы он также проверил ее.
  4. Если инструкция готовится для вашей компании, попросите начальника проверить ее.
  5. Дайте работу на проверку новичку.
  - Проверка неопытным специалистом поможет понять, насколько понятно изложен текст для людей, у которых в данной области минимум знаний.

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

Из статьи вы узнаете:

Правила и порядок оформления должностных инструкций в 2017 году

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

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

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

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

Правила оформления должностных инструкций в 2017 году

Как правило, в должной инструкции содержатся следующие разделы:

Общие положения;
Должностные обязанности;
Права по должности;
Ответственность.

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

Текст инструкции печатается только на одной стороне листа. При этом установлены следующие границы текста: верхняя и нижняя равны 2 см , правая - 1,5 см , левая - 3 см . Как правило для текста используется шрифт Times New Roman Cyr или Arial размером 14 или 12 пт соответственно.

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

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

Порядок оформления должностных инструкций

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

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

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

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

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

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

Как сделать выписку из должностной инструкции

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

Выписки , в том числе и из должностных инструкций в 2017 году оформляются в соответствии с требованиями Указа Президиума ВС СССР от 04.08.1983 №9779. Они должны быть напечатаны на бланке предприятия, на котором уже указаны такие реквизиты, как его наименование и справочные сведения об организации. Выписку необходимо заверить подписью руководителя или уполномоченного на то должностного лица и печатью.

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

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

Образцы оформления должностных инструкций

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

Текстовое содержание полей образца представлено в таблице.

Номер поля реквизита	Текстовое содержание поля реквизита
	Предназначено для указания полного наименования предприятия - разработчика инструкции
	Место расположения грифа утверждения. При его заполнении слово УТВЕРЖДАЮ пишется без кавычек прописными буквами. Обязанность по утверждению такого рода документов руководитель организации, как правило, оставляет за собой или же назначает приказу ответственное лицо, которому такое право передает. В этом же поле должна быть указана должность лица, утвердившего документ, а также - его подпись, расшифровка и дата утверждения
	Размещается текстовое содержание инструкции.

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

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

Шаблон должностной инструкции приведен ниже.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

KISS

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

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

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

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

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

Clear screen/clear desk

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

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

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

Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

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

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

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

1. Стандарты

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

IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»;
ГОСТ 19:
- ГОСТ 19.402-78 ЕСПД. Описание программы;
- ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению;
- ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению;
- ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению;
- ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

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

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

2. Структура

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

Хорошее руководство пользователя должно содержать:

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

Также руководство пользователя может содержать:

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

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

3. Пользователи

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

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

Уважайте пользователей системы, не пишите инструкции в пренебрежительном стиле.

4. Особенности изложения

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

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

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

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

Хорошо : In File menu, select Save item .
Хуже : Select Save item from File menu.

4.2 Используйте повелительное наклонение , не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо : Click Logout .

Хуже : It is needed to click Logout to log out current user account from the system.

Хуже : If user wants to log out current user account from the system(s)he needs to click Logout.

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

Хорошо:
To create project :

Click the Create button on toolbar.
On the Create Project overlay fill in all mandatory fields.
Click the Save button to save the project.

Хуже : To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

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

Хорошо : When user clicks the Start button, the program starts the process.

Хуже : When user clicks the Start button, the program will start the process.

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

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

Разумеется, орфографические ошибки недопустимы.

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

Например, не допускайте, чтобы в одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент – combobox или dropdown list. Это путает пользователя.

4.7 Разумно используйте сокращения и исключите жаргон .

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

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

5. Внешний вид

5.1 Продумайте стиль документа . Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

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

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

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

6. Поддержка

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

Заключение

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

Помните главное: документ должен помогать пользователям.

Статью подготовила

Тарасюк Надежда, участник сообщества сайт,

аналитик с 6-летним опытом в сфере.