#базаЗнаний #статьи #оформление # Правила написания статьи ## 1. Общие требования 1. Назначение базы знаний - хранение и обеспечение доступа к знаниям, идеям и важным документам. 2. Статья должна соответствовать назначению базы знаний. 3. Название стать должно отражать ее содержание и быть уникальным для базы знаний, то есть если статья с таким названием уже есть в статье, его нужно изменить. ## 2. Требования к формату и синтаксису 1. Статья для базы знаний должны быть оформлена с использованием разметки [markdown](https://ru.wikipedia.org/wiki/Markdown) 2. Рекомендуется использовать программу [Obsidian/](https://obsidian.md/) 3. Полное описание синтаксиса оформления доступного для статьи можно найти в [Obsidian help](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax) 4. Рекомендуемый размер статьи - не более 5000 символов. В случае выхода за рекомендуемые границы, разделите статью на несколько если это возможно. ## 3. Требования к разметке и оформлению 1. Добавляйте теги на первой строке статьи, для имени тега используйте стиль [сamelCase](https://ru.wikipedia.org/wiki/CamelCase) 2. Разделяйте объемную статью заголовками 1-4 уровня для формирования автоматического содержания по следующему принципу: ``` # Заголовок раздел статьи ## 1. Заголовок подраздела статьи ### 1.1. Заголовок пункта #### 1.1.1. Заголовок подпункта - строка 1 - строка 2 ``` 3. Для пошаговых инструкций рекомендуется использовать заголовки 3 уровня для оформления шагов, в соответствии с шаблоном: ``` ### Шаг 1: Описание первого шага (первый шаблон) 1. Описание действий подпункта. 2. Описаний действий подпункта. ### Шаг 2: Описание второго шага (второй шаблон с именами подпунктов) 1. **Имя подпункта**: Описание действий подпункта. 2. **Имя подпункта**: Описание действий подпункта. ``` 4. Названия файлов, параметров, типов, команд и т.п., а так же текст, который может содержать символы разметки, например `**примеры синтаксиса**`, `Составные_Названия` или `..\путь\к файлу\`, обрамляйте символом обратного апострофа (такая кавычка на клавише "ё") 5. Названия команд должны быть полными, то есть включать имена окон, вкладок, панелей, кнопок, лейблов и т.п. Для разделения полей используйте символ - `→` с пробелами , для выпадающих списков и диалоговых окон - `↓` > [!example] > `Архитектура → Строительство → Импост` > `Вид → Создаине → Спецификации↓ → Список листов` > `Системы → ОВК↓ → Настройка систем ОВиВК → Параметры воздуховодов → Круг → Новый размер...` > `Файл → Параметры → Интерфейс → Горячие клавиши: Настроить... → Экспорт...` > [!tip] > Для быстрой вставки символа стрелок используйте [Alt-код](https://ru.wikipedia.org/wiki/Alt-код) > Например, для вставки `→` нужно зажать `ALT` и ввести `26` 6. Обрамляйте текст угловыми скобками `< >` там где необходимо указать заполняемое значение или диапазон значений. > [!example] > Заполнение: > `<Поле1>_<Поле2>_<Поле3>_<Поле4>_<Поле5>_<Поле6>` > > Повторения: > > |Имя параметра| |---| |`ADSK_Штамп Строка <1..6> должность`| |`ADSK_Штамп Строка <1..6> фамилия`| |`ІТЕМ_Штамп Строка <1..6> дата`| 7. Тест в публикуемой статье требующий доработки необходимо выделять маркером, например: ====здесь дописать пример==== 8. Акцентируйте внимание используя выноски для: > [!note] > Заметок > [!info] > Важной информации > [!summary] > Резюме > [!tip] > Трюков > [!success] > Проверок > [!help] > Вопросов > [!warning] > Предупреждений > [!failure] > Проблем > [!danger] > Опасных ситуаций > [!bug] > Багов > [!example] > Примеров > > [!quote] > Описаний ## 4. Требование к ссылкам и ресурсам 1. Ссылки на статьи базы знаний должны оформляться внутренними ссылками: ``` [[Название статьи на которую ссылаемся]] [[Название статьи на которую ссылаемся|Отображаемый текст ссылки]] ``` 2. Допускается использовать ссылку на заголовки внутри статьи, но текст заголовка должен быть без пробелов: ``` [[#Текст-заголовка]] [Отображаемый текст ссылки](#Текст-заголовка) ``` 3. Во внутренних ресурсах базы знаний разрешается использовать только изображения, для прочих используйте внешние ссылки: ``` [Отображаемый текст ссылки](адресс ресурса) ``` 4. Если в статью требуется добавить изображение, это изображение должно находиться в папке с именем `_resources\<Имя статьи>`, при этом имена изображений должны быть уникальны для всей БЗ, например содержать имя статьи и порядковый номер или [GUID](https://ru.wikipedia.org/wiki/GUID): ``` ..\ \_resources\ \Создание статьи для базы знаний\ Создание статьи для базы знаний 1.png 70d76504-bdff-44d8-b08f-2db9daaea952.png Создание статьи для базы знаний.md ``` > [!example] > Примеров > ![[Создание статьи для базы знаний 1.png]] 5. Рекомендуемые размеры изображений: - 1024x768 - 640x480 - 320x240 6. Размер изображения не должен превышать 1 МБ, рекомендуемый размер - до 200 КБ. 7. Для добавления в статью видео используйте `iframe`: ``` <iframe width="640" height="480" src="https://www.youtube.com/embed/yU7Ju0CSKxE" title="Itemika Test" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> ``` ## 5. Сложное форматирование 1. Для более сложного оформления допускается использовать `html`, например <details> <summary>для сворачивающегося</summary> текста [[Создание шаблона семейства ITEM]] </details> ```html <details> <summary>для сворачивающегося</summary> текста [[Создание шаблона семейства ITEM]] </details> ``` для <span style="background:#3333AA">изменения </span><span style="background:#33AA33">фона </span><span style="background:#AA3333">текста</span> ```html для <span style="background:#3333AA">изменения </span><span style="background:#33AA33">фона </span><span style="background:#AA3333">текста</span> ``` ## 6. Требования к названию 1. Название должно кратко и полно описывать тему статьи. 2. Если статья относится к определенному блоку статей, его название пишется впереди статьи. Для разделения используется точка. > [!example] > Неправильно: "Размещение колонн АР" > Правильно: "Размещение архитектурных колонн в Revit" > Правильно: "Шаблон АР. Описание шаблонов видов" 3. Запрещается ставить точку или другие знаки препинания в конце названия статьи. ## 7. Добавление тегов 1. В самом верху статьи, под ее названием, добавляйте связанные со статьей теги с помощью символа `#`, например: ``` #базаЗнаний #статьи #оформление ``` 2. Для названия тега используйте стиль [CamelCase](https://ru.wikipedia.org/wiki/CamelCase) со строчной (маленькой) первой буквой. Имена собственные, например "Revit" всегда пишутся с заглавной. 3. Перед добавлением тегов рекомендуется поискать уже имеющиеся подходящие теги в поиске базы знаний.