Page History
Здесь мы собрали минимально необходимую информацию для оформления статьи в Confluence.
Здесь мы собрали всё, что знаем, чтобы сделать инструкции максимально полезными и понятными 
В ПИК инструкции объясняют кому, что и в каком порядке надо делать для выполнения задачи (операции, процедуры). Инструкции отличаются от других корпоративных документов своей конкретикой и ориентацией на действие. Они не содержат общих описаний, в отличие от политик и регламентов.
Цель инструкции — предложить алгоритм действий (конкретные шаги) или объяснить особенности, что поможет достигнуть требуемого результата с минимальными затратами времени и ресурсов.
Подготовка
| Expand | ||
|---|---|---|
| ||
Чтобы быстро начать и подготовить основу для инструкции, воспользуйтесь простой формулой «Что–Зачем–Как» и ответьте на три вопроса:
|
| Expand | ||
|---|---|---|
| ||
Определите, какая цель у вашей инструкции, кому она предназначена и чем будет полезна. Представьте свою целевую аудиторию, тогда текст будет настроен именно на неё, информация будет полезной и понятной.
|
| Expand | ||
|---|---|---|
| ||
Это краткая запись содержания, своего рода скелет. План отображает порядок и последовательность изложения информации. Он состоит из предложений или ключевых слов, которые определяют основное содержание текста. Существуют виды планов: вопросный, назывной, опорный, тезисный, цитатный. Для подготовки инструкции чаще всего используют назывной или тезисный план.
|
| Expand | ||
|---|---|---|
| ||
(от лат. structura — строение, расположение, порядок) — это внутренняя организация текста, взаимосвязь его частей. Структура определяет логическое и хронологическое разделение, а также последовательность событий, идей или информации в тексте. Структура текста определяется его стилем и жанром. Так, у информационных статей, регламентов, политик, инструкций или постов в соцсетях будут разные структуры. Структура инструкции обычно состоит из четырёх частей: заголовок, общие положения/описание (сюда можно включить цель), основной текст (шаги или особенности использования) и приложения.
|
| Expand | ||
|---|---|---|
| ||
Если вы готовите несколько типовых инструкций, разработайте шаблон. Шаблоны обеспечивают чёткую структуру и логическую последовательность, что упрощает восприятие инструкций. Они также обеспечивают единый стиль и формат, делая инструкции более понятными. Использование шаблонов помогает соблюдать корпоративные стандарты документации. И, наконец, шаблоны ускоряют процесс создания инструкций, поскольку основная работа по структурированию и форматированию уже выполнена. Не существует универсального шаблона для всех инструкций. В зависимости от уровня целевой аудитории, назначения, специфики задач, которые должна решать инструкция, и текущей ситуации, шаблоны могут отличаться. Так, например, инструкция для BIM-специалиста будет отличаться от инструкции, предназначенной для проектировщика. Это связано с тем, что BIM-специалист обладает знаниями, которые позволяют ему быстрее освоить информацию. Инструкция для проектировщика должна быть более подробной и разъяснительной, чтобы она была понятной для людей без специальной подготовки. Также инструкция по использованию BIM-инструмента будет отличаться от инструкции по BIM-требованиям к модели. В каждом случае необходима своя структура. |
| Expand | ||
|---|---|---|
| ||
|
| title | Стиль |
|---|
Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные.
Пишите и общайтесь гендерно-нейтрально.
Всегда сохраняйте вежливый и нейтральный тон. В тексте может использоваться обращение к пользователю на «ты», но старайтесь всю коммуникацию делать обезличенной.
Будьте осторожны с юмором: он не должен быть слишком ярким или задевать чьи-то чувства.
| Expand | ||
|---|---|---|
| ||
«Стандартной страницей» текста (формат А4) обычно считается 1800 печатных знаков с пробелами. Чтение такого объёма может занять 8-10 минут. Статистика также показывает, что человек способен воспринимать однообразную информацию не дольше 20 минут.
|
Оформление
Здесь собраны методические и технические правила оформления текста.
Создание новой страницы
Чтобы создать новую страницу, выберите категорию,
затемпространство и раздел. Так, создаваемая страница будет связана с выбранным разделом.
Например:
- Дисциплина → Архитектурный BIM → Коммерция → Подразделы → Создать новую страницу
- Сервисы → Учебный центр BIM →
- Развитие → Создать новую страницу
Нажмите значок «Создать» в правом верхнем углу.
Выберите
шаблон или используйте пустую страницу.
Создание нового раздела с вложенными страницами
Создайте новую страницу — это будет страница раздела. Внутри неё создавайте страницы статей.
Перейдите в режим редактирования на странице нового раздела, в верхнем меню выберите «Вставить прочий контент»
Выберите в списке «Другие макросы», через поиск найдите «Отображение дочерних»
Вставьте макрос, чтобы все эти вложенные страницы были видны на странице раздела.
Оформление заголовка
Введите заголовок страницы.
Общие правила составления заголовков
Заголовки страниц должны быть уникальными. Это важно для поисковой системы.
Не ставьте точку в конце залоговка, это не принято. В составном заголовке между смысловыми частями можно ставить знаки препинания.
| Плохо | Хорошо |
|---|---|
Проемы и отверстия в стенах. | Проемы и отверстия в стенах Стены. Проемы и отверстия Стены: проемы и отверстия |
Используйте общепринятые термины и аббревиатуры.
| Плохо | Хорошо |
|---|---|
Оформление ДМ Подбетонка | Оформление демонстрационных материалов Бетонная подготовка |
Структурируйте текст, придерживайтесь подхода «От общего к частному». Не дублируйте название предыдущего уровня, если логическая цепочка не обрывается.
| Плохо | Хорошо |
|---|---|
Инструменты PIKTools Общие инструменты Общая Печать листов | PIKTools Общие инструменты Печать листов |
Заголовки страниц должны быть уникальными. Это важно для поисковой системы.
Добавьте к заголовку дополнительные слова или аббревиатуру, если в разных подразделах у вас должны
находиться инструкции с одинаковыми названиями
, то вы можете добавить к заголовку дополнительные слова или аббревиатуру.
Разместите уточнение в конце заголовка, чтобы в начале находилось уникальное
название. Соблюдение этого правила сделает работу с каталогом удобнее.
| Плохо | Хорошо |
|---|
|
|
Вставка оглавления
Вставьте оглавление, если в тексте больше двух-трёх абзацев
.
| Info |
|---|
Разместите оглавление непосредственно перед основным текстом. Вводный текст, который объясняет цели документа, должен быть перед оглавлением. |
Прежде всего оформите заголовки блоков/рубрик текста через встроенную систему заголовков (это необходимо для использования макроса).
Выберите макрос «Оглавление» через функцию «Вставить прочий контент» в верхнем меню
.
Задайте
уровни заголовков, которые должны отображаться, в настройках. Чтобы увидеть результат, используйте кнопку «Предварительный просмотр».
| Info |
|---|
Оглавление следует разместить непосредственно перед основным текстом. При этом вводный текст, объясняющий цели документа, должен быть расположен перед оглавлением. |
Если вы хотите закрепить оглавление при прокрутке страницы,
используйте макрос Easy Heading Macro.
Выберите «Вставить прочий контент» → «Другие макросы» и введите название в поисковую строку.
Реализацию можно посмотреть прямо в этой статье или в учебных
инструкциях к курсам «Технология проектирования в Revit»:
Если вам нужно закрепить оглавление при прокрутке страницы, а также добавить все ссылки из статьи, то используйте макрос «Плавающее содержание».
Выберите «Вставить прочий контент» → «Другие макросы» и введите название в поисковую строку.
Реализация в режиме просмотра:
Реализацию также можно посмотреть в учебных инструкциях к курсам «Технология проектирования в Revit»: Проверить и исправить дубликаты семейств
Форматирование текста
Используйте в инструкции простые предложения. Разделяйте текст для лучшего восприятия. Соблюдайте правило: в одном абзаце - 4-5 предложений. В предложении должно быть 8-10 слов. Если слов больше, разделите на два предложения.
Выполняйте основной текст стилем «Абзац», для деления текста применяйте
систему заголовков.
Или воспользуйтесь инструментом «Разметка страницы».
Используйте также разделительную линию, чтобы зонировать текст.
Форматируйте тест при помощи встроенных инструментов.
Используйте списки при перечислениях
, вам доступны два вида.
Маркированный список, когда позиции списков не имеют последовательности. При этом если у одной позиции есть преимущества (например, чаще используется), то такую позицию нужно поставить в начало.
- Пример
- Пример
- Пример
Нумерованный список, когда позиции списка
расположены в заданной последовательностиимеют заданную последовательность.
- Действие
- Действие
- Действие
Используйте также разделительную линию, чтобы зонировать текст.
Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.
Выделяйте важное в тексте.
Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив:ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ!
Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью. Для выделения блока лучше использовать эмодзи или символы: ☝ или специальные блоки. Можно также использовать слова: Внимание!Совет и др.
Введите систему маркировки для типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки.
Например:
полужирный шрифт — для описания названий элементов интерфейса и кнопок
прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем
курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)
рамка — для оформления фрагментов кода
маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация
| Info |
|---|
Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить» Верхние кавычки, или лапки — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай). Сочетание клавиш в Windows для ёлочек: « — alt + 0171 |
Используйте макрос Info, чтобы выделить текст в виде блока
.
| Warning |
|---|
| Note |
|---|
| Info |
|---|
| Tip |
|---|
Оформляйте содержательные ссылки на другие ресурсы
Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуете материал из других источников больше 20%
.
Соблюдайте авторское право. Указывайте название источника заимствования, если этого материала больше 20% в отношении объема вашей статьи, или вы использовали изображения из внешней среды.
Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.
Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».
Если вы не обновили статью, то все внесенные изменения сохранятся в виде неопубликованных.
Визуализация
Добавляйте изображения Добавьте визуализацию к тексту.
Для этого используйте наиболее удобный вам способ.Вложения
Сначала загрузите файл (изображение, видео, презентация, PDF, аудио) с компьютера на страницу Confluence. Файл будет отображаться на странице и одновременно станет вложением. Чтобы просмотреть вложения на странице, нажмите на значок «Скрепка» в режиме чтения.
Вам откроется:
Вы можете удалить изображение на странице, но файл останется во вложении. Чтобы окончательно удалить изображение, нужно удалить файл в режиме «Вложения».
Добавляйте изображения удобным вам способом.
Перетащите объект в поле страницы в режиме редактирования.
Следите за названием изображений, если вы добавите на страницу новое изображение с таким же названием, то старое изображение автоматически заменится на новое.
Воспользуйтесь
инструментом меню «Вставить изображение»
. Этой функцией удобно пользоваться, если вы работаете с набором изображений.
Отроется окно с функций «Загрузить файлы». После загрузки файлов, вы можете выбрать нужные для вставки. Нажмите кнопку «Вставить».
Используйте стандартные функции настройки изображения. Выберите то, что вам нужно: изменить размер, добавить границу, вставить ссылку, открыть окно свойств.
Окно «Свойства изображения» имеет два режима: эффекты и описание.
В режиме «Описание» вы можете добавить подпись для изображения, которая будет появляться при наведении на него:
Задайте изображениям содержательные названия, тогда они будут попадать в выдачу по поиску.
Это также поможет вам, если одно и то же изображение нужно разместить на разных страницах. Не придётся дублировать изображение несколько раз.
По умолчанию в каталоге сохраняется название изображения, включая формат и путь. Это можно увидеть в режиме редактирования при наведении на изображение:
| title | Добавление меток |
|---|
Вставляйте контент со встроенным плеером и возможностью управления. Вы можете добавить документы в формате PDF, а также аудио- и видеофайлы.
Файл PDF
Перетащите PDF-документ с компьютера в пространство Confluence. Удалите его на странице, при этом он сохранился во вложении страницы.
Вставьте макрос PDF.
Выберите страницу, с которой должен подгружаться файл PDF. Поскольку это единственный подходящий файл для макроса, он сразу отображается в блоке «Имя файла». Если на странице несколько таких файлов, то нужно выбрать нужный из выпадающего списка.
Результат в режиме редактирования:
Результат в режиме просмотра:
Файл PDF отображается через внутренний интерфейс, пользователь может перелистывать страницы.
Аудио- и видеофайлы (до 700 Мб)
Перетащите аудио- и видеофайлы с компьютера в пространство Confluence. Удалите их на странице, при этом они сохранились во вложении страницы.
Вставьте макрос Multimedia.
Выберите страницу и файл для отображения на странице публикации.
Результат в режиме просмотра:
Используйте макрос «Свойства страницы», чтобы показать только часть контента, например, слайд презентации.
Вставьте документ, который нужно скрыть на странице:
Вставьте макрос PowerPoint. Выберите страницу, имя файла (презентация) и номер слайда, который нужно отобразить на странице:
Результат в режиме редактирования:
Результат в режиме просмотра:
Добавление меток
Добавляйте метки в режиме просмотра или редактирования. Раздел или страница не должны оставаться без меток. Это важно для упорядочивания контента. Метки помогают быстро находить близкую по содержанию информацию, используя фильтрацию поиска по метке.
При создании новых разделов и страниц обязательно следует проставлять метки их принадлежности:
- к дисциплине (разделу проектирования): АР, КР, ЭОМ и т.д.
- к инструментам и ПО: Revit, Civil 3D, Family Manager, BIM Inspector, PIKTools и т.д.
- к сервису: BIM-поддержка , BIM-координация, Фабрика семейств, Учебный центр.
Раздел или страница не должны оставаться без меток. Это важно для упорядочивания контента. Метки помогают быстро находить близкий по содержанию контент, используя фильтрацию поиска по метке.
Добавить метку к тексту можно двумя способами.
Для созданной страницы используйте значок добавления метки, расположенный в правом нижнем углу.
В режиме редактирования используйте значок метки над заголовком страницы.
В диалоговом окне введите названия необходимых меток и нажмите кнопку «Добавить». Если метка с таким именем уже существует, она появится в меню автоподстановки.
Если название новое, оно добавится в каталог.
Общие правила наименования:
- Давайте меткам понятные, содержательные имена. или общепринятые сокращения. Допустимо использовать кириллицу и латиницу.
- Не ориентируйтесь на различия по прописным и строчным буквам, замена на строчные происходит автоматически.
- По возможности ставьте слова в им. падеже и единственном числе.
- Добавляйте нижнее подчёркивание или дефис в словосочетаниях, иначе отдельные слова добавятся в каталог как разные метки.
| Плохо | Хорошо |
|---|---|
инструкции но! требование bim координатор Civil 3D | инструкция требования bim-координатор civil3d |
Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует.
Общие правила размещения меток:
Чтобы не придумывать новые правила, используйте уже разработанную систему
. Посмотрите правила Группы BIM-
поддержкиподдержки Метки инструкций.
ЕслиЕсли вы создаёте для своего раздела собственные правила, то следуйте общим рекомендациям:
Не создавайте множество меток, по которым можно найти только одну страницу. Учитывайте все алгоритмы поиска: через наименование страницы происходит конкретизация поиска
- Добавляйте метки к странице по принципу «от общего к частному»
| Обязательные → | Категории, пространства, раздела → | Дополнительные → | Основные (суть темы) |
|---|---|---|---|
| bim проектный_блок кадры маркетинг и т.д. | ар | коммерция | оси |
Проверка
| title | Редактирование текста |
|---|
- Сложные конструкции — разбиваем на несколько предложений
- Страдательный (пассивный) залог — меняем конструкции предложений
- Отглагольные существительные — меняем на глаголы
- Канцеляризмы — удаляем
- Вводные слова — проверяем на уместность
- Риторические вопросы — проверяем на уместность
- «Воду» — отжимаем
- Сленг — удаляем (это правило для источника информации, который попадает в публичное пользование, можно оставлять только профессиональные термины)
| title | Проверка текста |
|---|
| Easy Heading Macro | ||||
|---|---|---|---|---|
|
| Expand | ||
|---|---|---|
| ||
Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям:
|
Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!