Правила оформления статей
Заголовки
При оформлении заголовков необходимо использовать только стили предложенные в редакторе
Дополнительное форматирование не допускается
| ✔️Правильно |
❌Неправильно |
БольшойСреднийМаленькийКрошечный |
БольшойСреднийМаленькийКрошечныйХрен пойми какой |
Так же следует соблюдать структуру заголовков. Структура заголовков должна соответствовать смысловой структуре текста.
И следует помнить, что заголовок, это не просто текст большего размера - это элемент навигации.
Основной контент
Оформление текста
Для оформления текста абзацев используем стиль Обычный текст
При оформлении текста следует придерживаться следующих правил:
- Для выделения важных элементов текста используем только полужирное начертание. Полужирное начертание используется обычно в двух случаях:
- Когда мы ходим написать имя собственное без кавычек
- Когда мы хотим выделить ключевые слова для лучшего усвоения текста при беглом прочтении.
- Не допускается выделение текста курсивом, подчеркиванием и цветом, кроме случаев указанных ниже.
- Не допускается отступ в начале абзаца (красная строка, табуляция).
- Для перечисления элементов рекомендуется использовать маркированные и нумерованные списки. Нумерованному списку следует отдавать предпочтение, если планируется ссылаться на его пункты.
- Если в документе представлен список задач или какой-то типовой чеклист, то используем список типа Список задач
| ✔️Правильно | 👌Допустимо |
❌Неправильно |
|
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий.
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий. |
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий.
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий.
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий.
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий. |
|
|
«РОСА» – это сервисная инженерная компания, которая разрабатывает уникальные архитектурно-строительные проекты «под ключ», следуя последним тенденциям, используя инновационные технологии. |
РОСА – это сервисная инженерная компания, которая разрабатывает уникальные архитектурно-строительные проекты «под ключ», следуя последним тенденциям, используя инновационные технологии. |
РОСА – это сервисная инженерная компания, которая разрабатывает уникальные архитектурно-строительные проекты «под ключ», следуя последним тенденциям, используя инновационные технологии. |
Выделение текста цветом
Используется только в тех случаях, когда нам необходимо указать, что текст относится к графическому элементу на изображении того же цвета.
| ✔️Правильно |
❌Неправильно |
 |
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий. |
Если необходимо сделать сильный акцент на каком-то фрагменте текста при помощи цвета, то сделать это всё же можно при помощи выносок.
Выделение текста курсивом
Следует использовать только для добавления подписей к изображениям.
| ✔️Правильно |
❌Неправильно |
|
Рисунок 1. Какой-то человек работает в Autocad |
Это метод планирования проектов, при котором этапы работы четко разграничены и идут последовательно: новый этап начинается, только когда закончен предыдущий.
|
Оформление цитат
Для оформления цитат используется стиль Цитата
Выглядит это так:
Логика является основой достоверности всех знаний, которые мы приобретаем.
Леонард Эйлер
Выноски
Выноски - это фрагменты текста выделенные в особый блок. Их главная задача привлечь внимание читателя или предупредить о чем-либо. Создаются они через стиль Выноска.
Вот примеры выносок:
В Tekla Structures начиная с версии 2022 появился новый тип объектов - арматурная сборка
Поздравляю! Если на предыдущих шагах всё сделано верно, то в конце у Вас будет отчет в фомате XLS, на этом расчет закончен.
К заданию шага сетки нужно подходить очень внимательно! Слишком мелкий шаг сетки приводит к кратному росту времени расчета!
Если про открытии модели Tekla Вы видите сообщение о том, что модель открыть невозможно из-за повреждения диска - это значит, что модель повреждена и ее восстановление невозможно!
Выноски - это элементы, которым лучше не злоупотреблять и выделять только то, что очень важно.
Оформление программного кода
Если необходимо отделить какой-то исполняемый код, от сопроводительного текста, то есть возможность использовать Встроенный код, либо блок кода.
Ваш
код
здесь!Если необходимо в тексте упомянуть путь до файла, то оформляем его как код, например С:\Tekla Structures
То же самое касается функций и атрибутов, например GetValue('ASSEMBLY_PREFIX')
Оформление таблиц
Особых требований к оформлению таблиц нет, но следует придерживаться следующих правил.
- Если в статье несколько таблиц, то необходимо для них соблюдать одинаковое оформление.
- Если требуется цветовое оформление, то использовать не более 2-х разных цветов
- Цвета желательно выбирать неяркие, приглушенные.
Редактор таблиц конечно же далек от Excel и по удобству и по функциям, поэтому пара советов:
- Предварительно рассчитайте нужное количество столбцов в таблице и сразу создавайте таблицу нужного размера, тогда таблица будет сразу аккуратно разбита на нужное количество одинаковых столбцов. Если добавлять столбцы после создания таблицы, то регулировка ширины столбцов может стать хлопотным делом.
- Таблицу и ее элементы можно форматировать, даже если это не очевидно с первого взгляда. Для этого сначала выбираете нужный диапазон, а затем открываете подменю работы с таблицами и задаете нужное свойство.
Оформление диаграмм и схем
Если статья требует наличия какой-то схема, диаграммы, небольшого рисунка, которого у вас нет готовом виде и его предстоит создать, то лучше всего это сделать при помощи встроенного редактора схем.
Копирование текста из других источников в базу знаний
При копировании текста из другого источника важно понимать, что он копируется с форматированием.
- гарнитуру и размер шрифта
- межстрочные интервалы
- цвет текста
- и т.д.
После копирования текста всегда нужно сбрасывать форматирование.
| ✔️Правильно |
❌Неправильно |
|
Жизнь в большом городе зачастую накладывает на людей очень много обязательств, которые многим мешают планировать свое время. Поэтому времени катастрофически не хватает на все, в том числе и на нормальную здоровую пищу.
Полезные продукты необходимо включать в рацион каждый день: они богаты аминокислотами, витаминами, микро- и макроэлементами, жирными кислотами, клетчаткой. На самом деле мы боремся не за вкус еды, а со своей ленью, потому что нам очень удобно купить полуфабрикаты или готовые продукты, чтобы быстрее приготовить.
С целью снизить число людей с ожирением рестораны быстрого питания и сети супермаркетов вводят новые, более полезные опции (например, салаты, сэндвичи с цельнозерновым хлебом или напитки без сахара), а также предоставляют информацию о пищевой ценности продуктов в меню или на упаковке.
Вторично разогретая пища, особенно если после её приготовления прошло уже несколько часов, практически не содержит ни витаминов, ни других полезных веществ. На поведение потребителей могут повлиять не только вкусовые предпочтения, но и немедленные желания получить определенную еду.
Здоровый праздничный ужин вовсе не обязательно должен состоять из шпината, гречки и вареной куриной грудки. Самыми лучшими способами приготовления еды являются следующие: варка на пару, запекание или варка в воде. Помимо стандартных мандаринов и ананасов, отличным украшением любого стола станут необычные, экзотические фрукты. Здоровой может быть даже выпечка, если она приготовлена на пару.
Текст в таблице взят с рыбатекст.рф.
|
Жизнь в большом городе зачастую накладывает на людей очень много обязательств, которые многим мешают планировать свое время. Поэтому времени катастрофически не хватает на все, в том числе и на нормальную здоровую пищу.
Полезные продукты необходимо включать в рацион каждый день: они богаты аминокислотами, витаминами, микро- и макроэлементами, жирными кислотами, клетчаткой. На самом деле мы боремся не за вкус еды, а со своей ленью, потому что нам очень удобно купить полуфабрикаты или готовые продукты, чтобы быстрее приготовить.
С целью снизить число людей с ожирением рестораны быстрого питания и сети супермаркетов вводят новые, более полезные опции (например, салаты, сэндвичи с цельнозерновым хлебом или напитки без сахара), а также предоставляют информацию о пищевой ценности продуктов в меню или на упаковке.
Вторично разогретая пища, особенно если после её приготовления прошло уже несколько часов, практически не содержит ни витаминов, ни других полезных веществ. На поведение потребителей могут повлиять не только вкусовые предпочтения, но и немедленные желания получить определенную еду.
Здоровый праздничный ужин вовсе не обязательно должен состоять из шпината, гречки и вареной куриной грудки. Самыми лучшими способами приготовления еды являются следующие: варка на пару, запекание или варка в воде. Помимо стандартных мандаринов и ананасов, отличным украшением любого стола станут необычные, экзотические фрукты. Здоровой может быть даже выпечка, если она приготовлена на пару.
Текст в таблице взят с рыбатекст.рф. |
Скрытые блоки для любознательных
В некоторых случаях статья может содержать большой объем важных пояснений. При этом пояснения могут быть крайне полезны в будущем, но не требуются для решения текущей задачи. Тут, пожалуй, трудно сходу найти подходящий пример, но такое бывает часто.
Пояснения можно убирать в специальный свернутый блок
Нажмите чтобы раскрыть
Важное пояснение
Использование эмодзи✏️
Только приветствуется👍
Найти нужное изображение можно здесь: https://emojipedia.org