Библиотека:Редакторам

Материал из Национальной библиотеки им. Н. Э. Баумана
Последнее изменение этой страницы: 16:20, 24 апреля 2020.
Версия от 16:20, 24 апреля 2020; ksenia varaksina (обсуждение | вклад)

(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

Infobox example.png

Определение

Как правило, один абзац текста, который даёт определение и краткую информацию по рассматриваемому объекту (решению, продукту, компании и т.д.).

Например:

Национальная библиотека им. Н. Э. Баумана — это некоммерческий проект, целью которого является создание библиотеки, обеспечивающей сохранность и доступность информации в электронном виде. Проект является бесплатным сервисом без рекламы, и каждый может искать любую имеющуюся в ней информацию. Национальная библиотека им. Н. Э. Баумана существует с лета 2015 года. Ресурс является непрерывно обновляемым за счёт работы студентов и научного персонала.

Содержание

Собирается автоматически при использовании в оформлении заголовков.

Infobox

Infobox — информационный блок в верхнем правом углу, содержащий справочные данные о рассматриваемом объекту. Инфобокс выбирается из списка шаблонов на странице Справка:Infobox.

История

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

Основной текст статьи

Содержит основную информацию по рассматриваемому объекту. Основной текст может представлять как один блок, так и несколько. Например, в отдельные блоки могут быть вынесены системные требования, основные функции, процесс установки, сравнение с аналогами и т.д. Основными источниками информации должны выступать официальные ресурсы, связанные с рассматриваемым объектом, комментарии и обзоры объекта в СМИ.

Примечания

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

Источники

При использовании любой информации в обязательном порядке нужно указать её источник. Оформление ссылок должно быть выполнено по ГОСТ.

Доп. литература

Цель этого раздела – предоставить список дополнительных источников, напрямую не задействованных в статье, но способных помочь в раскрытии темы. Это могут быть как библиографические ссылки, так и ссылки на электронные ресурсы. Оформление должно соответствовать ГОСТу.

Оформление статьи

Оформление кода

Если в статье присутствует код, его необходимо оформить через SyntaxHighlight. С другой стороны, если вы приводите листинг команд, то воспользуйтесь Справка:Консоль.

Code example.png

Оформления изображений

Для логотипов используйте формат .svg. Для изображений, содержащих текст, используйте формат .png. Изображения, использующиеся в статье, подписываются в соответствии с ГОСТ 7.32-2017 СИБИД.

Внутренние ссылки

См. также


Демки

Демка (демо-видео) – это видео с демонстрацией работы и/или установки ПО.

Демо-видео записывается любой программой захвата экрана. Крайне желательно, чтобы программа не накладывала на видео ватермарки/логотипы на пол-экрана.

Видео записываются без звука, без фоновой музыки. Как правило, для понимания происходящего на видео, не требуется каких-либо дополнительных комментариев, кроме описанного в статье. Если такие комментарии всё же требуются, нужно накладывать субтитры.

Демка может быть снята (не взята из интернета!) для свободно распространяемых программ (в т. ч. СУБД и ОС) и зачтена в качестве отдельного задания.

Готовые демки не требуется вставлять в статью. Видео в хорошем разрешении нужно отправить на info@bmstu.wiki, после проверки оно будет вставлено в статью модераторами.