Шаблон статьи с инструкциями

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

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

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

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

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

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

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

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

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

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