Page History
Здесь мы собрали всё, что знаем, чтобы сделать инструкции максимально полезными и понятными.
В ПИК инструкции объясняют
Вы работаете в ПИК? Значит, вы уже автор инструкций или станете им завтра!
Инструкции для нас — это как советы друга, которые помогают качественно и быстро выполнить рабочие задачи.
Однако, некоторые наши инструкции могут быть сложными, похожими на научные статьи. Именно по этой причине многие не открывают их до момента, пока «всё пошло не так». Такая ситуация может привести к более серьезным проблемам. Например, если сотрудники не изучили инструкцию и не поняли, как работает инструмент, они не смогут его использовать и будут решать задачи при помощи «костылей». Упс! А это нарушает технологический процесс и влияет на качество продукта компании.
Вот почему важно уделить время и разобраться, как написать полезную и понятную инструкцию! Мы собрали здесь информацию, которая вам в этом поможет 
В ПИК инструкции используют для объяснения кому, что и в каком порядке надо делать для выполнения задачи (операции, процедуры). Инструкции отличаются от других корпоративных документов своей конкретикой и ориентацией на действие. Они не содержат общих описаний, в отличие от политик и регламентов.
Цель инструкции — предложить алгоритм действий (конкретные шаги) или объяснить особенности, что поможет достигнуть требуемого результата с минимальными затратами времени и ресурсов.
ЭТОТ ТЕКСТ УЙДЁТ В ЧЕК_ЛИСТ
Качество инструкций обеспечивают простые принципы:
- Ясность: текст должен быть понятен и прост для восприятия
- Краткость: в инструкции нет лишней информации, передана только суть
- Последовательность: шаги логически выстроены
- Детализация: каждый шаг описан достаточно подробно
- Визуализация: текст сопровождается графикой, иллюстрациями и скриншотами
- Надёжность: есть подтверждение, что инструкция работает, она протестирована
- Эффективность: прочтение инструкции занимает не больше времени, чем это необходимо
| Table of Contents |
|---|
СДЕЛАТЬ РАСКРЫВАЮЩИМИСЯ СПИСКАМИ
Подготовка
| Expand | |
|---|---|
|
| |
Чтобы быстро начать и подготовить основу для инструкции, воспользуйтесь простой формулой «Что–Зачем–Как» и ответьте на три вопроса:
|
| Expand | ||
|---|---|---|
| ||
Определите, какая цель у вашей инструкции, кому она предназначена и чем будет полезна. Представьте свою целевую аудиторию, тогда текст будет настроен именно на неё, информация будет полезной и понятной.
|
| Expand | ||
|---|---|---|
| ||
Это краткая запись содержания, своего рода скелет. План отображает порядок и последовательность изложения информации. Он состоит из предложений или ключевых слов, которые определяют основное содержание текста. Существуют виды планов: вопросный, назывной, опорный, тезисный, цитатный. Для подготовки инструкции чаще всего используют назывной или тезисный план.
|
| Expand | |
|---|---|
|
| |
(от лат. structura — строение, расположение, порядок) — это внутренняя организация текста, взаимосвязь его частей. Структура определяет логическое и хронологическое разделение, а также последовательность событий, идей или информации в тексте. Структура текста определяется его стилем и жанром. Так, у информационных статей, регламентов, политик, инструкций или постов в соцсетях будут разные структуры. Структура инструкции обычно состоит из четырёх частей: заголовок, общие положения/описание (сюда можно включить цель), основной текст (шаги или особенности использования) и приложения.
|
| Expand | ||
|---|---|---|
| ||
Если вы готовите несколько типовых инструкций, разработайте шаблон. Шаблоны обеспечивают чёткую структуру и логическую последовательность, что упрощает восприятие инструкций. Они также обеспечивают единый стиль и формат, делая инструкции более понятными. Использование шаблонов помогает соблюдать корпоративные стандарты документации. И, наконец, шаблоны ускоряют процесс создания инструкций, поскольку основная работа по структурированию и форматированию уже выполнена. Не существует универсального шаблона для всех инструкций. В зависимости от уровня целевой аудитории, назначения, специфики задач, которые должна решать инструкция, и текущей ситуации, шаблоны могут отличаться. Так, например, инструкция для BIM-специалиста будет отличаться от инструкции, предназначенной для проектировщика. Это связано с тем, что BIM-специалист обладает знаниями, которые позволяют ему быстрее освоить информацию. Инструкция для проектировщика должна быть более подробной и разъяснительной, чтобы она была понятной для людей без специальной подготовки. Также инструкция по использованию BIM-инструмента будет отличаться от инструкции по BIM-требованиям к модели. В каждом случае необходима своя структура. |
| Expand | ||
|---|---|---|
| ||
|
|
|
|
|
|
|
|
| Expand | ||
|---|---|---|
| ||
Используйте информационный стиль — полезный, простой, понятный. Формулируйте мысли коротко и просто (в предложении 8-10 слов). Фокус должен быть на решении задачи (проблемы) или действии пользователя. Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные.
|
|
|
|
|
|
старайтесь всю коммуникацию делать обезличенной.
|
| Expand | ||
|---|---|---|
|
«Стандартной страницей» текста (формат А4) |
обычно считается 1800 печатных знаков с пробелами. |
Чтение такого объёма |
может занять 8-10 |
минут. |
Статистика |
также показывает, что человек способен воспринимать однообразную информацию не дольше 20 минут. |
|
стоит оформить оглавление или разбить одну инструкцию на две. |
Проверка
- Указывайте назначение инструкции перед основным текстом
- Оформляйте оглавление
- Используйте преимущественно простые конструкции предложений
- Оформляйте содержательные ссылки на другие ресурсы
- Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуем материал из других источников больше 20%
Введите маркировку типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки.
Например:
полужирный шрифт — для описания названий элементов интерфейса и кнопок
прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем
курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)
рамка — для оформления фрагментов кода
маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация
Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив:
ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ!
Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью.
Для выделения блока лучше использовать иконки, эмодзи или символы: ☝
Можно также использовать слова Внимание! Совет! и др.
| Expand | ||
|---|---|---|
|
Вычитайте подготовленный текст. Каждую найденную сущность из списка ниже нужно ставить под сомнение. Если вы не сможете чётко ответить, почему она здесь — удаляйте или переделывайте:
|
| Expand | ||
|---|---|---|
| ||
|
|
|
| Expand | ||
|---|---|---|
| ||
Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям:
|
Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!