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

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

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

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

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

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

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

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

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

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

Детализация

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

Например:

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

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

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

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

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

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

Сравните:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Сравните:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Как написать должностную инструкцию

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

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

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

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

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

Обычно должностная инструкция содержит пять разделов:

1. Общие положения:

— точное и полное наименование должности работника;

— уровень оплаты труда, условий премирования, методы поощрения;

— подчиненность работника и наличие у работника подчиненных;

— порядок замещения работника в случае его отсутствия (отпуск, командировка, болезнь и т д.);

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

2. Основные задачи:

— задачи, выполнение которых возлагается на работника;

— конкретные обязанности работника, выполнение которых обеспечивает решение поставленных перед ним задач.

3. Права:

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

4. Ответственность:

— ответственность работника за невыполнение обязанностей;

— ответственность данного работника за действия его подчиненных, если таковые есть.

5. Требования к работнику:

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

Зачем нужна должностная инструкция

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

Ведь должностная инструкция — это:

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

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

Существует множество видов предоставления справочной информации пользователю – это и 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 :

1. Click the Create button on toolbar.
2. On the Create Project overlay fill in all mandatory fields.
3. 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-летним опытом в сфере.