Page History
Если вы зашли на эту статью, значит, вы автор инструкций или станете им завтра!
Инструкции помогают нам легко справляться с рабочими задачами. Но иногда наши инструкции похожи на научные статьи, и их сложно читать. Многие игнорируют их до момента, пока «упс, что-то пошло не так». Это может привести к серьёзным проблемам, например, к неправильному использованию инструментов, нарушению технологического процесса и, как следствие, ухудшению качества продукта компании. Поэтому так важно правильно составлять инструкции.
Здесь мы собрали всё, что знаем, чтобы сделать инструкции максимально полезными и понятными
понятными.
Подготовка
| Expand | ||
|---|---|---|
| ||
Чтобы быстро начать и подготовить основу для инструкции, воспользуйтесь простой формулой «Что–Зачем–Как» и ответьте на три вопроса:
|
| Expand | ||
|---|---|---|
| ||
Определите, какая цель у вашей инструкции, кому она предназначена и чем будет полезна. Представьте свою целевую аудиторию, тогда текст будет настроен именно на неё, информация будет полезной и понятной.
|
| Expand | ||
|---|---|---|
| ||
Это краткая запись содержания, своего рода скелет. План отображает порядок и последовательность изложения информации. Он состоит из предложений или ключевых слов, которые определяют основное содержание текста. Существуют виды планов: вопросный, назывной, опорный, тезисный, цитатный. Для подготовки инструкции чаще всего используют назывной или тезисный план.
|
| Expand | ||
|---|---|---|
| ||
(от лат. structura — строение, расположение, порядок) — это внутренняя организация текста, взаимосвязь его частей. Структура определяет логическое и хронологическое разделение, а также последовательность событий, идей или информации в тексте. Структура текста определяется его стилем и жанром. Так, у информационных статей, регламентов, политик, инструкций или постов в соцсетях будут разные структуры. Структура инструкции обычно состоит из четырёх частей: заголовок, общие положения/описание (сюда можно включить цель), основной текст (шаги или особенности использования) и приложения.
|
| Expand | ||
|---|---|---|
| ||
Если вы готовите несколько типовых инструкций, разработайте шаблон. Шаблоны обеспечивают чёткую структуру и логическую последовательность, что упрощает восприятие инструкций. Они также обеспечивают единый стиль и формат, делая инструкции более понятными. Использование шаблонов помогает соблюдать корпоративные стандарты документации. И, наконец, шаблоны ускоряют процесс создания инструкций, поскольку основная работа по структурированию и форматированию уже выполнена. Не существует универсального шаблона для всех инструкций. В зависимости от уровня целевой аудитории, назначения, специфики задач, которые должна решать инструкция, и текущей ситуации, шаблоны могут отличаться. Так, например, инструкция для BIM-специалиста будет отличаться от инструкции, предназначенной для проектировщика. Это связано с тем, что BIM-специалист обладает знаниями, которые позволяют ему быстрее освоить информацию. Инструкция для проектировщика должна быть более подробной и разъяснительной, чтобы она была понятной для людей без специальной подготовки. Также инструкция по использованию BIM-инструмента будет отличаться от инструкции по BIM-требованиям к модели. В каждом случае необходима своя структура.Пример шаблона |
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Используйте информационный стиль — полезный, простой, понятный. Формулируйте мысли коротко и просто (в предложении 8-10 слов). Фокус должен быть на решении задачи (проблемы) или действии пользователя. Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные.
|
| Expand | ||
|---|---|---|
| ||
«Стандартной страницей» текста (формат А4) обычно считается 1800 печатных знаков с пробелами. Внимательное чтение текста Чтение такого объёма займёт в среднем 9может занять 8-10 минут. Статистика также показывает, что человек способен воспринимать однообразную информацию не дольше 20 минут.
|
Оформление
| Expand | ||
|---|---|---|
| ||
|
стоит оформить оглавление или разбить одну инструкцию на две. |
| title | Публикация в Confluence |
|---|
Чтобы создать новую страницу, нажмите значок «Добавить» в правом верхнем углу.
Выберите свой шаблон или используйте пустую страницу.
Введите заголовок страницы. Не используйте в названии специальные символы ! @ # № $ % ^ & ? : они могут быть некорректно обработаны системой.
Не ставьте точку в конце залоговка, это не принято. В составном заголовке между смысловыми частями можно ставить точку или запятую.
Стены: проемы и отверстия.
Стены. Проемы и отверстия
Оформление ДМ
Подбетонка
Оформление демонстрационных материалов
Бетонная подготовка
Общее описание технологии армирования нетиповых этажей
Армирование. Общее описание. Нетиповые этажи
Основной текст выполняйте стилем «Абзац». Для деления текста используйте систему заголовков.
Не дублируйте название предыдущего уровня, если логическая цепочка не обрывается.
Инструменты PIKTools
Общие инструменты
Общая Печать листов
PIKTools
Общие инструменты
Печать листов
Оформляйте перечисления в виде списков, вам доступны два вида.
Маркированный, когда позиции списков не имеют последовательности. При этом если у одной позиции есть преимущества (например, чаще используется), то такую позицию нужно поставить в начало.
- Пример
- Пример
- Пример
Нумерованный, когда позиции списка расположены в заданной последовательности.
- Действие
- Действие
- Действие
Используйте также разделительную линию, чтобы зонировать текст.
Изучите макросы, это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.
Добавляйте метки (tag) к странице.
При создании новых разделов, подразделов, страниц нужно добавлять метки принадлежности:
- к разделу проектирования: АР, КР, ИОС, ЭОМ и т.д.
- к программному обеспечению: Revit, Civil 3D
- к подразделению
Если страница не относится ни к одному из разделов проектирования - ставим метку "Общий"
Если страница не относится ни к одному программному обеспечению (Revit, Civil3D, Renga, NanoCAD) - ставим только метку раздела проектирования "Общий, АР, КР и т.д." Страница или раздел не должны быть пустыми (без меток). Это важно для сбора информации в базу данных чат-бота "Виртуальный координатор".
Описание формулировок меток по разделам и ПО собрано в файле Слова и фразы на русском языке, общепринятые слова и сокращения допускается писать на латинице
Не допускается дублирование одинаковых меток в единственном и множественном числе
В словосочетаниях используйте _ (нижнее подчеркивание, а не - (дефис)) или пробел, иначе каждое слово после пробела преобразуется в отдельную метку)
Чем больше вариаций и релевантных фраз и слов, тем лучше Добавлять метки к странице от общего к частному
Добавить новую метку в Список ниже (временный пункт)
Не добавлять большое количество меток, по которым можно найти только 1 страницу (конкретизация поиска добивается через наименование страницы)
Для инструкций отдела BIM добавлять метку bim_координатор (н е администратор и другие)
Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».
| title | Маркировка |
|---|
Введите маркировку типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки.
Например:
полужирный шрифт — для описания названий элементов интерфейса и кнопок
прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем
курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)
рамка — для оформления фрагментов кода
маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация
| Info |
|---|
Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить» Верхние кавычки, или лапки — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай). Сочетание клавиш в Windows для ёлочек: « — alt + 0171 |
| title | Выделение текста |
|---|
Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив:
ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ!
Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью.
Для выделения блока лучше использовать эмодзи или символы: ☝ или специальные блоки. Можно также использовать слова: Внимание!Совет и др.В Confluence
Текст можно выделить при помощи макроса Info:
Проверка
| Expand | ||
|---|---|---|
| ||
Вычитайте подготовленный текст. Каждую найденную сущность из списка ниже нужно ставить под сомнение. Если вы не сможете чётко ответить, почему она здесь — удаляйте или переделывайте:
|
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям:
|
Примеры инструкций
Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!