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
Общие инструменты
Печать листов
Expand | ||
---|---|---|
| ||
Добавьте цели и укажите, кто целевая аудитория (если потребуется). Это поможет читателю сориентироваться, о чём текст. Здесь можно также указать связь с другими документами, если этого сложно добиться другими способами (классификация уровней, метки). |
title | Вставка оглавления |
---|
Вставьте оглавление, если в тексте больше двух абзацев.
Прежде всего оформите заголовки блоков/рубрик текста через встроенную систему заголовков (это необходимо для использования макроса).
стоит оформить оглавление или разбить одну инструкцию на две. |
Добавьте макрос «Оглавление». В настройках задайте уровни заголовков, которые должны отображаться. Чтобы увидеть результат, используйте кнопку «Предварительный просмотр».
Info |
---|
Оглавление следует разместить непосредственно перед основным текстом. Вводный текст, объясняющий цели документа, должен быть расположен перед оглавлением. |
title | Форматирование текста |
---|
Основной текст выполняйте стилем «Абзац». Для деления текста используйте систему заголовков.
Форматируйте тест при помощи встроенных инструментов.
Оформляйте перечисления в виде списков, вам доступны два вида.
Маркированный, когда позиции списков не имеют последовательности. При этом если у одной позиции есть преимущества (например, чаще используется), то такую позицию нужно поставить в начало.
- Пример
- Пример
- Пример
Нумерованный, когда позиции списка расположены в заданной последовательности.
- Действие
- Действие
- Действие
Используйте преимущественно простые конструкции предложений
Оформляйте содержательные ссылки на другие ресурсы
Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуете материал из других источников больше 20%
Разбивайте текст для улучшения его восприятия. Следуйте правилу: один абзац должен содержать 4-5 предложений. Или воспользуйтесь инструментом «Разметка страницы».Используйте также разделительную линию, чтобы зонировать текст.
Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.
Выделяйте текст.
Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив:ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ! Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью. Для выделения блока лучше использовать эмодзи или символы: ☝ или специальные блоки. Можно также использовать слова: Внимание!Совет и др.Введите систему маркировки для типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки.
Например:
полужирный шрифт — для описания названий элементов интерфейса и кнопок
прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем
курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)
рамка — для оформления фрагментов кода
Info |
---|
Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить» Верхние кавычки, или лапки — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай). Сочетание клавиш в Windows для ёлочек: « — alt + 0171 |
Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».
Добавляйте метки.
Используйте значок добавления метки, расположенный в правом нижнем углу созданной страницы.
Или над заголовком страницы, если статья режиме редактирования.
В диалоговом окне введите слова необходимых меток и нажмите кнопку «Добавить».
Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует.
Проверка
Expand | ||
---|---|---|
| ||
Вычитайте подготовленный текст. Каждую найденную сущность из списка ниже нужно ставить под сомнение. Если вы не сможете чётко ответить, почему она здесь — удаляйте или переделывайте:
|
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям:
|