Структура написания руководства - RukovodstvoRus.ru - инструкции пользования и руководства

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

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

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

3 основных вида инструкций

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

Пошаговая инструкция

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

Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:

Откройте верхнюю крышку и извлеките блок фотобарабана
Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
Вытащите тонер-картридж
Поставьте на его место новый
Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
Установите фотобарабан обратно в принтер
Закройте крышку
Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает – обратитесь к системному администратору

Инструкция по использованию

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

В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:

В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic – 160-180°C.
Максимальное время работы ламинатора – 4 часа. Затем нужно сделать получасовой перерыв.
Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его.
Внимание! Не ламинируйте влажные образцы – жидкость может повредить электронные компоненты!
После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством.
Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию!

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

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

Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:

Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
Бригадир раздает списки, по которым комплектуются грузы.
Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
Если есть необходимость, грузчик может привлекаться к другим работам на территории склада – уборке, контролю за въездом транспорта и пр.

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

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

Общие правила при подготовке инструкций

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

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

Алгоритм разработки руководства: 9 шагов

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

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

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

Шаг 1. Изучить ситуацию

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

Шаг 2. Разложить все на отдельные этапы

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

Запустить программу Microsoft Word
Создать новый документ
Набрать необходимый текст
Отформатировать его
Сохранить файл
Сообщить в бухгалтерию, что заявление подготовлено

Шаг 3. Описать каждый этап

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

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

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

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

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

Шаг 4. Рассмотреть нестандартные варианты развития ситуации

Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:

3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры

Шаг 5. Подобрать изображения и привести примеры

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

Шаг 6. Придумать заголовок

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

«Как написать инструкцию по подготовке заявления»
«6 шагов для подготовки электронного документа»
«Простой способ написать заявление на компьютере»
«Подробный алгоритм подготовки документа для безбумажного оборота»

Шаг 7. Оценить промежуточный вариант

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

Как написать простую инструкцию (образец):

Запустите программу Microsoft Word
Нажмите на раздел «Новый документ» в правой части экрана
Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
Отформатируйте набранный текст с помощью верхней панели программы Word.
- Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
- Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
- Выделите список спецодежды и примените к нему функцию «Маркированный список»

Сохраните файл. Для этого:
- Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
- Выберите путь сохранения файла
- В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
- Нажмите кнопку «Сохранить»
Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено.

Пример объявления, на который можете ориентироваться при подготовке:

Шаг 8. Тестирование

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

Проверьте алгоритм с помощью этих вопросов:

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

Шаг 9. Обучить сотрудников по инструкции

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

Особенности такого обучения:

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

Примеры готовых инструкций

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

Вывод

Резюмируя все изложенное, можно составить требования к идеальной инструкции:

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

Вам будет интересно

Готовые курсы для бизнеса: проверенные агрегаторы онлайн курсов

Как учиться эффективно: проверенная технология обучения

Где провести вебинар: лучшие программы для вебинаров

Перейти на главную блога

Источник

Как написать инструкцию так, чтобы тебя поняли

Время на прочтение
2 мин

Количество просмотров 45K

Есть такая поговорка: «Хочешь сделать хорошо — сделай сам».

Для себя, действительно, так будет быстрее и спокойнее. Однако любому руководителю известно, что плохой менеджер это тот, кто не умеет объяснять и делегировать полномочия. Соответственно, умение давать четкие инструкции и план действий — задача хорошего руководителя. А помогает ему в этом «юзабельность». Давайте и разберёмся с этим понятием.

Юзабилити (от англ. usability) означает удобство в использовании, эргономичность и легкость в понимании.

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

Итак, а теперь непосредственно к главному.

Выражение: «И так сойдет» — точно не для инструкций.

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

2. Не используем в инструкции много сленга. Есть шанс, что не все сотрудники его поймут.
Пример: «Уточнить у манагеров, получила ли апрув статья». С одной стороны, написано всё понятно, но для официального документа такой сленг не подходит.

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

Примеры скриншотов с вполне понятными шагами:

4. Не пропускаем шаги, которые кажутся нам слишком простыми. Пусть лучше сотрудник, читая инструкцию, сам пропустит этот степ.

5. В тексте нежелательно использовать большие предложения. Коротко: «Зайдите в меню», «Добавьте значение…», «Выберите параметр…» и т.д.

6. Для сокращения объема текста возможно применение графических элементов. Например,

Local area connection ——> properties—>TCP/IPv4—>properties.

7. Применение шрифтовых выделений допустимо. Это привлекает внимание на особо важных пунктах.

8. Не используйте в инструкции ничего из вашего личного опыта применения того или иного продукта или использования программы. Для этого существуют отдельные встречи с сотрудниками, где вы передаете им свой ценный опыт. А инструкция — это логичная структура, где описан «шаг — действие» и ничего более.

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

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

Источник

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

Журавлев Денис

Что такое руководство пользователя и для чего его создавать

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

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

Общие советы по созданию пользовательской документации

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

После этого важно подумать о том:

Где пользователь будет к нему обращаться: дома, на работе, в машине?
Как часто он будет его просматривать?
Насколько объективно сложен для понимания продукт?

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

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

Структура руководства пользователя

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

В первом разделе желательно рассказать общую информацию о программе:

Для чего создан продукт.
Какие задачи он решает.
Какие основные выгоды от использования для клиента.

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

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

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

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

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

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

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

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

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.

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

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

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

Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

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

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

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

Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert

Николай Вальковец, разработчик компании 2V

«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».

Прочитать кейс компании V2

Подытожим

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

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

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

Источник

Система качества является зоной ответственности высшего руководства организации и требует их активного участия и поддержки персонала. Одним из ключевых документов является руководство по качеству. Оно требуется как общими стандартами на системы менеджмента качества, такие как ISO 9001, так и отраслевыми, такими как ICH Q10 из Части 3 GMP и пункт 1.2 GDP.

Александр Александров, Виалек

Назначение Руководства по качеству

Прежде всего, руководство по качеству предназначено для

демонстрация соответствия стандартам, например GMP/GDP, ISO 9001 и др.;
навигатор по системе качества как части системы управления организацией;
основа для вовлечения в систему качества руководителей всех уровней организации;
элемент имиджевой политики, подтверждающий согласованность целей.

В каком-то виде Руководство по качеству (РК) – это первый документ, с которым кто-либо знакомится с системой качества организации. РК выполняет функцию справочника (Что? Где? и Как?), пользователи этого документа, совсем не ориентирующиеся (или слабо ориентирующиеся) в процессах и (или) документации системы качества, с его помощью могут оперативно найти нужную им информацию, узнавать о важных изменениях.

Составитель прежде всего должен идентифицировать целевую аудиторию РК, так как главный документ по качеству должен составляться с позиции ориентированности на потребителя (в данном случае на читателя). Если так сделать, это станет лучшей иллюстрацией назначения системы качества. К основным пользователям РК можно отнести:

собственник(и) предприятия;
руководители высшего звена;
руководители вовлеченных (да, и не вовлеченных) структурных подразделений;
специалисты подразделений;
аудиторы партнеров и (или) покупателей, заказчиков контрактного производства;
инспекторы надзорных органов.

Помимо прочего, составление Руководства по качеству имеет сакральный смысл. Именно этот документ системы качества должен давать ответы на вопросы:

Зачем нужна система качества?
Какова ее структура?
Как там все организовано?
Кто за что отвечает?

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

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

Связи с другими Руководствами

Как уже отмечалось, подготовка РК заявлена во многих стандартах на системы качества (в том числе в ISO 9001, GMP/GDP, ISO 13485, ISO 22000 и др.). Дополнительно, Часть 3 GMP требует составлять Досье производственной площадки (SMF), а стандарт ISO 17025 заявляет о необходимости подготовки руководства по качеству контрольной лаборатории. Поэтому, в интегрированных системах крайне важно выработать политику объединения (совмещения) и (или) информационной согласованности таких документов, так как по большей части они будут дублировать друг друга.

В простых интегрированных системах не нужно (и даже опасно) разрабатывать отдельные руководства по качеству специально для целей подтверждения ISO 9001, GMP/GDP, ISO 13485 и т.п. Это удобно для аудитора или инспектора, но вряд ли удобно для организации. В любом случае наличие в одной системе разных РК под разные стандарты – это признак формальных (не рабочих) систем.

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

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

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

Чаще всего встречается два типа структуры – либо РУ копирует структуру стандарта (ISO 9001, GMP/GDP), либо имеет индивидуальную (уникальную) структуру. Важна не форма, важно содержание.

Обычно РК содержит следующую информацию:

Краткая информация об организации:
- отраслевая принадлежность;
- продукция, услуги;
- корпоративная/ведомственная принадлежность;
- география присутствия.
Организационная структура предприятия (без излишних деталей).
Аутсорсинговая деятельность (наличие, отсутствие).
Модель процессов, ориентированная на взаимные связи.
(Политика качества).
(Цели в области качества).
Назначение системы качества, область ее применения, наличие исключений и (или) ограничений.
- Система мониторинга процессов и (или) качества продукции;
- Система управления корректирующими и (или) предупреждающими действиями (САРА);
- Система управления изменениями;
- Организация документации системы качества (3х, 4х-уровневая модель);
- Управление знаниями;
- Управление рисками (для качества);
- Анализ со стороны высшего руководства;
Уровень интегрированности с другими системами менеджмента и т.п.
(Декларация об открытости к аудитам).

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

Хорошее РК – это тонкое РК, не более 20-25 страниц. Если читатель захочет «углубиться» в детали, он найдет как это сделать.

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

Составитель РК должен выбрать адекватный уровень детализации описываемых процессов. Исходить нужно из назначения документа высшего уровня – помним, навигатор, первое знакомство с системой (проводник). Для этих целей достаточно краткого, лучше схематичного, описания процессов со ссылками на документы второго уровня.

Обратите внимание, что ссылки на документы низших уровней (3-го, 4-го) в «элитарном клубе» считается признаком «плохого» воспитания.

Алгоритм написания Руководства

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

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

Основные рекомендации:

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

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

Актуализация руководства

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

? Больше информации на Telegram-канале СЛУЖБА КАЧЕСТВА
Обсуждения, дискуссии вопросы-ответы ? в чате специалистов по качеству

Источник

Мой Телеграм

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

Этап №1. Как подготовиться к написанию инструкции

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

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

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

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

Этап №2. Как правильно писать инструкцию

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

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

Последовательность. Начинайте с… начала. Удивительно, но многие почему-то начинают писать инструкцию едва ли не с середины. Например, так: «в папке «Мои документы» откройте файл…» — учитывайте, что пользователь с минимальным уровнем знаний наверняка не знает, где искать ту самую папку. Объясните, где она находится.

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

И еще раз о терминологии. Если обойтись без нее нельзя, напишите приложение к инструкции – словарь. Либо поясняйте их прямо по тексту.

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

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

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

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

Немного о логической структуре инструкций

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

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

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

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

Этап №3. Проверка инструкций: читабельность, доступность и фактчекинг

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

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

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

Эксперт. Он поможет убрать фактические неточности и сделать инструкцию достоверной.

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

Источник