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 | Оформление заголовка |
|---|
Не ставьте точку в конце залоговка, это не принято. В составном заголовке между смысловыми частями можно ставить знаки препинания.
Проемы и отверстия в стенах.
Стены. Проемы и отверстия
Стены: проемы и отверстия
Оформление ДМ
Подбетонка
Оформление демонстрационных материалов
Бетонная подготовка
Общее описание технологии армирования нетиповых этажей
Армирование. Общее описание. Нетиповые этажи
Не дублируйте название предыдущего уровня, если логическая цепочка не обрывается.
Инструменты PIKTools
Общие инструменты
Общая Печать листов
PIKTools
Общие инструменты
Печать листов
Заголовки страниц должны быть уникальными. Это важно для поисковой системы.
В случае, если в разных подразделах у вас должны находится инструкции с одинаковыми названиями, то вы можете добавить к заголовку дополнительные слова или аббревиатуру.
Но желательно разместить это уточнение заголовка в конце, чтобы в начале находилось уникальное содержательное название. Соблюдение этого правила сделает работу с каталогом удобнее.
| title | Добавление цели |
|---|
| title | Вставка оглавления |
|---|
стоит оформить оглавление или разбить одну инструкцию на две. |
Прежде всего оформите заголовки блоков/рубрик текста через встроенную систему заголовков (это необходимо для использования макроса).
Добавьте макрос «Оглавление». В настройках задайте уровни заголовков, которые должны отображаться. Чтобы увидеть результат, используйте кнопку «Предварительный просмотр».
| Info |
|---|
Оглавление следует разместить непосредственно перед основным текстом. Вводный текст, объясняющий цели документа, должен быть расположен перед оглавлением. |
| title | Форматирование текста |
|---|
Для деления текста используйте систему заголовков.
Форматируйте тест при помощи встроенных инструментов.
При перечислениях используйте списки, вам доступны два вида.
Маркированный, когда позиции списков не имеют последовательности. При этом если у одной позиции есть преимущества (например, чаще используется), то такую позицию нужно поставить в начало.
- Пример
- Пример
- Пример
Нумерованный, когда позиции списка расположены в заданной последовательности.
- Действие
- Действие
- Действие
Используйте также разделительную линию, чтобы зонировать текст.
Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.
Выделяйте текст.
Введите систему маркировки для типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки.
Например:
полужирный шрифт — для описания названий элементов интерфейса и кнопок
прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем
курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)
рамка — для оформления фрагментов кода
| Info |
|---|
Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить» Верхние кавычки, или лапки — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай). Сочетание клавиш в Windows для ёлочек: « — alt + 0171 |
Оформляйте содержательные ссылки на другие ресурсы
Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуете материал из других источников больше 20%
Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».
| title | Визуализация |
|---|
Перетащите объект в поле страницы в режиме редактирования.
Воспользуйтесь инструментом меню «Вставить изображение». Этой функцией удобно пользоваться, если вы работаете с набором изображений.
Отроется окно с функций «Загрузить файлы». После загрузки файлов, вы можете выбрать нужные для вставки. Нажмите кнопку «Вставить».
Используйте стандартные функции настройки изображения. Выберите то, что вам нужно: изменить размер, добавить границу, вставить ссылку, открыть окно свойств.
Окно «Свойства изображения» имеет два режима: эффекты и описание.
В режиме «Описание» вы можете добавить подпись для изображения, которая будет появляться при наведении на него:
Это поможет вам, если одно и то же изображение нужно разместить на разных страницах. Не придётся дублировать изображение несколько раз.
По умолчанию при наведении на изображение отображается его название и формат, включая путь:
| title | Добавление меток |
|---|
- к дисциплине (разделу проектирования): АР, КР, ЭОМ и т.д.
- к инструментам и ПО: Revit, Civil 3D, Family Manager, BIM Inspector, PIKTools и т.д.
- к сервису: BIM-поддержка , BIM-координация, Фабрика семейств, Учебный центр.
Раздел или страница не должны оставаться без меток. Это важно для упорядочивания контента. Метки помогают быстро находить близкий по содержанию контент, используя фильтрацию поиска по метке.
Добавить метку к тексту можно двумя способами.
Для созданной страницы используйте значок добавления метки, расположенный в правом нижнем углу.
В режиме редактирования используйте значок метки над заголовком страницы.
В диалоговом окне введите названия необходимых меток и нажмите кнопку «Добавить». Если метка с таким именем уже существует, она появится в меню автоподстановки. Новое имя добавится в каталог.
Общие правила наименования:
- Давайте меткам понятные, содержательные имена. или общепринятые сокращения. Допустимо использовать кириллицу и латиницу.
- Не ориентируйтесь на различия по прописным и строчным буквам, замена на строчные происходит автоматически.
- По возможности ставьте слова в им. падеже и единственном числе.
- Добавляйте нижнее подчёркивание или дефис в словосочетаниях, иначе отдельные слова добавятся в каталог как разные метки.
инструкции
но! требование
bim координатор
Civil 3D
инструкция
требования
bim-координатор
civil3d
Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует.
Общие правила размещения меток:
Не создавайте множество меток, по которым можно найти только одну страницу. Учитывайте все алгоритмы поиска: через наименование страницы происходит конкретизация поиска
- Добавляйте метки к странице по принципу «от общего к частному»
проектный_блок
кадры
маркетинг
и т.д.
ар
кр
эом
revit
civil3d
fm
bim-inspector
piktools
bim-поддержка
bim-координация
фс
уц
и т.д.
коммерция
реновация
рабочая_документация
спецификация
задача
обучение
новости
р22 (шифр проекта)
и т.д.
оси
координаты
помещение
вор
реестр
ошибка
ипр
отпуск
и т.д.
Проверка
| Expand | ||
|---|---|---|
| ||
Вычитайте подготовленный текст. Каждую найденную сущность из списка ниже нужно ставить под сомнение. Если вы не сможете чётко ответить, почему она здесь — удаляйте или переделывайте:
|
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям:
|
Примеры инструкций
Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!