Статья с инструкциями

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

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

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

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

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

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

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

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

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

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