Close

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

Автор: ATLASSIAN

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

Использование шаблона
Шаблон статьи с инструкциями

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

Сведения об использовании шаблона

Шаг 1. Будьте мастером своего дела

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

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

Шаг 2. Составьте описание

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

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

Шаг 3. Соберите иллюстрации, схемы и снимки экрана

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

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

Шаг 3. Соберите иллюстрации, схемы и снимки экрана

Шаг 4. Узнайте мнение других

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

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

Шаг 5. Публикуйте и ждите отзыва

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

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


Atlassian — это компания, разрабатывающая корпоративное программное обеспечение для разработчиков ПО, руководителей проектов и управления контентом.

  • AWS architecture diagram template

    Lucidchart

    Схема архитектуры AWS

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

  • DevOps runbook template

    ATLASSIAN

    Перечень задач DevOps

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

  • DevOps change management template

    ATLASSIAN

    Управление изменениями DevOps

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