Как сделать оформление статьи более удобным для читателей

В этом документе собраны рекомендации по написанию статьей Базы знаний и их оформлению.

Название статьи

Пишите короткое и понятное название для статьи. Название не должно включать несущественную информацию и много подробностей, но в то же время оно должно дать понять читателю, что предложенный материал решает какую-то конкретную «проблему».

Структура статьи

Последовательность изложения

...

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

Выделение

Для логического выделения слов в тексте следует использовать полужирное и курсивное начертания шрифта.

...

Полужирным курсивом выделяются производные термины, не являющиеся синонимами основного предмета статьи, но также определяемые в её тексте.

Знаки препинания

При расстановке знаков препинания в тексте статей в первую очередь следует руководствоваться действующими правилами русского языка.

Запятая, точка с запятой, двоеточие, точка, многоточие, вопросительный и восклицательный от предшествующего слова пробелом не отделяются, но отделяются одиночным пробелом от последующего слова

Прочие советы

• Используйте предопределенные системой шаблоны.
• Обращайте внимание на то, как оформляют публикации другие пользователи. Почти каждый день для этого публикуется множество примеров.
• Обращайте внимание на отступы. У разных объектов они разные – у заголовков один отступ, у картинки или тега с кодом – другой. Некрасиво, когда в публикации есть лишние переносы строк, а картинки «прилипают» к тексту.
• Пользуйтесь орфографом/типографом. Дефисы, кавычки, многоточия и т.д. – это на ваше усмотрение. Но вот грамматические ошибки мало кому понравятся – исправляйте хотя бы то, что подчёркивает браузер.

Описание области знаний

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

Основные разделы

Добавьте ссылки на ключевые статьи области знаний для удобства поиска и навигации