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