Инструкция: Как писать инструкции и регламенты
** Цель инструкции: Установить единый стандарт создания, оформления и поддержки документов базы знаний, чтобы они были понятными, полезными и профессиональными.
1. Основные принципы (Философия документа)
Прежде чем писать, ответь на три вопроса:
Зачем? Какую проблему решает документ? Какую задачу упрощает?
Для кого? Кто будет его читать? (Новичок/опытный сотрудник/руководитель).
Что? Какой конкретный результат должен получить читатель после прочтения? (Сделать что-то, понять что-то, решить проблему).
Ответы на эти вопросы помогут составить план регламента и определить его цель
Правило 1: Регламент - это инструмент, а не отчёт или рассказ. Его ценность в экономии времени и снижении количества ошибок.
2. Структура документа
Каждый регламент должен следовать чёткой логике. Используй этот шаблон.
2.1. Шапка
Название: Чёткое и содержательное.
Лучше «Регламент проведения ОРМ», чем «Обучение на рабочем месте».
Версия и дата:
Например: Версия 1.2 от 25.10.2025
Владелец: ФИО или роль ответственного за актуальность. (на некоторых платформах, например LMS дата редакции и владелец выставляются автоматически)
Краткое описание (аннотация): 1-2 строки о том, что это за документ и для чего он нужен.
Пример: «Определяет порядок проведения синхронного обучения, при котором менеджер совершает звонки в присутствии ментора. Описывает критерии применения, подготовку, процесс и пост-обработку».
2.2. Тело документа (логическая последовательность)
Назначение и область применения: Подробнее раскрой «зачем» и «для кого». Опиши границы использования.
Термины и определения (Глоссарий): Дай расшифровку всех внутренних аббревиатур и терминов или дай ссылку на общий глоссарий, если такой есть. Это критически важно для новичков.
Процесс / Инструкция (ядро документа): Излагай информацию блоками, от общего к частному. Для процессов используй хронологию. Для сложных шагов - таблицы или другое подходящие визуальное оформление.
Ответственность и контроль: Кто что делает? Кто проверяет результат? (Можно использовать матрицу RACI для сложных процессов).
Связанные документы и ресурсы: Ссылки на шаблоны, формы, смежные регламенты, папки в Яндекс.Диске.
Приложения (если нужно): Скриншоты, шаблоны сообщений, примеры заполнения форм.
Правило 2: Структура должна позволять найти ответ за 30 секунд. Используй оглавление в больших документах.
3. Правила написания и оформления (Читаемость)
3.1. Язык и стиль
Безличная или повелительная форма:
«Необходимо создать мероприятие», «Создайте мероприятие». Избегай «мы», «ментор должен».
Простота: Предложения до 15-20 слов. Разбивай длинные конструкции. Заменяй канцеляризмы на простые слова
«осуществить» → «сделать», «в целях» → «для»
Конкретность:
«заполните необходимые поля» → «заполните поля: "Название", "Дата", "Ведущий"».
Активный залог:
«Ментор проверяет задание» (активно), а не «Задание проверяется ментором» (пассивно).
3.2. Визуальное оформление
Иерархия заголовков. Используй стили: H1 - заголовок , H2 - крупный раздел, H3 - подраздел
Списки: Используй для последовательности шагов - нумерованные списки. Для перечня условий, ресурсов, вариантов — маркированные.
Таблицы: Используй для сравнения, описания этапов с таймингом, классификации. Таблицы идеальны для структурирования сложной информации.
Выделение: Жирным выделяй ключевые термины, названия кнопок, систем. Курсивом — примечания, предупреждения.
Скриншоты: Делай их актуальными. Обязательно добавляй поясняющие рамки, стрелки или цифры на скриншоте.
Правило 3: Текст должен «дышать». Отступы между параграфами, списки и таблицы повышают читаемость.**