Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

light bulb  Здесь мы собрали минимально необходимую информацию для оформления статьи.



Expand
titleСоздание новой страницы

Чтобы создать новую страницу, выберите категорию, пространство и раздел. Так, создаваемая страница будет связана с выбранным разделом. 

Например:

  • Дисциплина → Архитектурный BIM → Коммерция → Подразделы → Создать новую страницу
  • Сервисы → Учебный центр BIM → Развитие → Создать новую страницу

check mark Нажмите значок «Создать» в правом верхнем углу.

check mark Выберите шаблон или используйте пустую страницу.

light bulb При создании Для создания нового раздела с вложенными со страницами, сначала создайте новую страницу . Это — это будет страница раздела. На ней Внутри неё создавайте страницы статей внутри. Чтобы все вложенные эти страницы отображались были видны на странице раздела, используйте макрос «Отображение дочерних». Через функцию В верхнем меню  выберите «Вставить прочий контент», затем «Другие макросы» в верхнем меню. 

 

Expand
titleОформление заголовка


check mark Введите заголовок страницы. 

check mark Не ставьте точку в конце залоговка, это не принято. В составном заголовке между смысловыми частями можно ставить знаки препинания. 

ПлохоХорошо

Проемы и отверстия в стенах.

Проемы и отверстия в стенах

Стены. Проемы и отверстия

Стены: проемы и отверстия


check mark Используйте общепринятые термины и аббревиатуры. 

ПлохоХорошо

Оформление ДМ

Подбетонка

Оформление демонстрационных материалов

Бетонная подготовка


check mark Структурируйте текст, придерживайтесь подхода «От общего к частному». Не дублируйте название предыдущего уровня, если логическая цепочка не обрывается.

ПлохоХорошо

Инструменты PIKTools

Общие инструменты

Общая Печать листов

PIKTools

Общие инструменты

Печать листов


light bulb Заголовки страниц должны быть уникальными. Это важно для поисковой системы.

В случае, если в разных подразделах у вас должны находиться инструкции с одинаковыми названиями, то вы можете добавить к заголовку дополнительные слова или аббревиатуру.

Желательно разместить это уточнение в конце заголовка, чтобы в начале находилось уникальное содержательное название. Соблюдение этого правила сделает работу с каталогом удобнее.

ПлохоХорошо


Expand
titleВставка оглавления


check mark
Вставьте оглавление, если в тексте больше двух абзацев. Для автоматической сборки используйте макрос. 

Прежде всего оформите заголовки блоков/рубрик текста через встроенную систему заголовков (это необходимо для использования макроса). 

Через функцию «Вставить прочий контент» в верхнем меню добавьте макрос «Оглавление». 

В настройках задайте уровни заголовков, которые должны отображаться. Чтобы увидеть результат, используйте кнопку «Предварительный просмотр».

Info

Оглавление следует разместить непосредственно перед основным текстом. При этом вводный текст, объясняющий цели документа, должен быть расположен перед оглавлением.

 
Если вы хотите закрепить оглавление при прокрутке страницы, то используйте макрос Easy Heading Macro. 

Выберите «Вставить прочий контент» → «Другие макросы» и введите название в поисковую строку.

face with monocle Реализацию можно посмотреть в учебных инструкция к курсам «Технология проектирования в Revit»: Написать заявку в поддержку


Expand
titleФорматирование текста


check mark Основной текст выполняйте стилем «Абзац». Используйте преимущественно простые конструкции предложений.

Для деления текста используйте систему заголовков. 

check mark Форматируйте тест при помощи встроенных инструментов.

check mark При перечислениях используйте списки, вам доступны два вида.

Маркированный список, когда позиции списков не имеют последовательности. При этом если у одной позиции есть преимущества (например, чаще используется), то такую позицию нужно поставить в начало.

  • Пример
  • Пример
  • Пример

Нумерованный список, когда позиции списка имеют заданную последовательность.

  1. Действие 
  2. Действие
  3. Действие


check mark Разбивайте текст для улучшения его восприятия.

Следуйте правилу: один абзац должен содержать 4-5 предложений. Или воспользуйтесь инструментом «Разметка страницы». 

 check mark Используйте также разделительную линию, чтобы зонировать текст. 



check mark Изучите макросы из основного списка и блока «Другие макросы». Это поможет вам автоматизировать задачи по организации контента. Вы сможете создавать структурированный и удобный для восприятия текст.

 check mark Выделяйте текст. 

Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив:ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ! 

Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью. Для выделения блока лучше использовать эмодзи или символы: или специальные блоки. Можно также использовать слова: Внимание!Совет и др.

Введите систему маркировки для типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки. 

Например:

  • полужирный шрифт — для описания названий элементов интерфейса и кнопок

  • прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем

  • курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)

  • рамка — для оформления фрагментов кода

  • маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация

Info

Кавычки предназначены, чтобы выделить слова внутри текста, а также исключить искажение смысла. Если шрифт выделяемого слова отличается от основного текста (аббревиатура, название на латинице), то кавычки не нужны. Например: компания ПИК ср. компания «Ромашка» или клавиша Tab ср. клавиша «Удалить»

Верхние кавычки, или лапки  — “” — легче набрать на клавиатуре, но их используют в английском языке. В русском языке правила всё же требуют использования кавычек, известных как «ёлочки». Лапки нам пригодятся, когда нужно что-то закавычить слово или словосочетание внутри уже закавыченного (это редкий случай).

Сочетание клавиш в Windows для ёлочек: 

« —  alt + 0171
» —  alt + 0187


Чтобы выделить текст в виде блока, используйте макрос Info: 

Warning


Note


Info


Tip



check mark Оформляйте содержательные ссылки на другие ресурсы

check mark Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуете материал из других источников больше 20%

check mark Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».

Expand
titleВизуализация


Добавляйте изображения к тексту. Для этого используйте наиболее удобный вам способ.

Перетащите объект в поле страницы в режиме редактирования. 

backhand index pointing up Следите за названием изображений, если вы добавите на страницу новое изображение с таким же названием, то старое изображение автоматически заменится.


Если вы работаете с набором изображений, воспользуйтесь инструментом меню «Вставить изображение». 

Отроется окно с функций «Загрузить файлы».  После загрузки файлов, вы можете выбрать нужные для вставки. Нажмите кнопку «Вставить».

Используйте стандартные функции настройки изображения. Выберите то, что вам нужно: изменить размер, добавить границу, вставить ссылку, открыть окно свойств.

Окно «Свойства изображения» имеет два режима: эффекты и описание. 

effects      

В режиме «Описание» вы можете добавить подпись для изображения, которая будет появляться при наведении на него:

light bulbЗадайте изображениям содержательные названия, тогда они будут попадать в выдачу по поиску.

Это поможет вам, если одно и то же изображение нужно разместить на разных страницах. Не придётся дублировать изображение несколько раз.

По умолчанию в каталоге сохраняется название изображения, включая формат и путь. Это можно увидеть в режиме редактирования при наведении на изображение:

Expand
titleДобавление меток


При создании новых разделов и  страниц обязательно следует проставлять метки их принадлежности:

  • к дисциплине (разделу проектирования): АР, КР, ЭОМ и т.д.
  • к инструментам и ПО: Revit, Civil 3D, Family Manager, BIM Inspector, PIKTools и т.д. 
  • к сервису: BIM-поддержка , BIM-координация, Фабрика семейств, Учебный центр. 

Раздел или страница не должны оставаться без меток.  Это важно для упорядочивания контента.  Метки помогают быстро находить близкий по содержанию контент, используя  фильтрацию поиска по метке. 

Добавить метку к тексту можно двумя способами.

Для созданной страницы используйте значок добавления метки, расположенный в правом нижнем углу.

В режиме редактирования используйте значок метки над заголовком страницы.

В диалоговом окне введите названия необходимых меток и нажмите кнопку «Добавить».  Если метка с таким именем уже существует, она появится в меню автоподстановки. Новое имя добавится в каталог.

Общие правила наименования:

  • Давайте меткам понятные, содержательные имена. или общепринятые сокращения.  Допустимо использовать кириллицу и латиницу. 
  • Не ориентируйтесь на различия по прописным и строчным буквам, замена на строчные  происходит автоматически
  • По возможности ставьте слова в им. падеже и единственном числе. 
  • Добавляйте нижнее подчёркивание или дефис в словосочетаниях, иначе отдельные слова добавятся в каталог как разные метки. 
ПлохоХорошо

инструкции

но! требование

bim координатор

Civil 3D

инструкция

требования

bim-координатор

civil3d

 Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует. 

Общие правила размещения меток:

light bulb Чтобы не придумывать новые правила, используйте уже разработанную систему

Правила Группы BIM-поддержки Метки инструкций

Если вы создаёте для своего раздела собственные правила, то следуйте рекомендациям: 

  • Не создавайте множество меток, по которым можно найти только одну страницу.  Учитывайте все алгоритмы поиска: через наименование страницы происходит конкретизация поиска

  • Добавляйте метки к странице по принципу «от общего к частному»
Обязательные →Категории, пространства, раздела →Дополнительные →Основные (суть темы) 
bim
проектный_блок
кадры
маркетинг
и т.д.

ар
кр
эом
revit
civil3d
fm
bim-inspector
piktools 
bim-поддержка 
bim-координация
фс 
уц
и т.д.

коммерция
реновация
рабочая_документация
спецификация
задача
обучение
новости
р22 (шифр проекта)
и т.д.

оси
координаты
помещение
вор
реестр
ошибка
ипр
отпуск
и т.д.





thumbs up Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!