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

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

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


Что такое статья?

Очень важно понимать, что написание статьи предполагает выполнение задачи по анализу существующих материалов, публикаций и иных источников информации по вашей тематике. Вам, как автору, необходимо развернуто и обстоятельно аргументировать изложенный материал в вашей статье. Также в статье вам обязательно необходимо подтвердить изложенные факты с помощью источников (это могут быть цифры, таблицы или дополнительная информация).

Исходные данные для статьи

Для написания качественной статьи жизненно необходимо собрать все имеющиеся исходных данных. Зачем это нужно? Во-первых, собирая исходные данные для статьи, вы видите направление, в котором вам нужно двигаться для раскрытия вашей темы. Во-вторых, пропуская тот или иной материал, вы можете изложить не достоверные факты и сделать ошибочные выводы.

Поиск информации для статьи

Конечно, это хорошо, если вы можете написать статью, основываясь на собственном опыте и эрудиции. Однако на практике вам придётся искать информацию в Сети. Хорошим подспорьем станут люди, которые «в теме». Вы можете эксплуатировать своих знакомых-экспертов в тех или иных областях для раскрытия темы.

Наращивание текстовой массы

Когда у Вас есть план, статья пишется в разы быстрее, чем если бы Вы сидели перед чистым листом бумаги. Все, что Вам нужно — это раскрыть каждый пункт, максимально подробно ответив на все сопутствующие вопросы (в пределах заданного объема, разумеется). При этом постарайтесь сделать так, чтобы каждый пункт плана выражал законченную мысль.

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

Вступление

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

Например, Вы пишете статью на тему мойки автомобиля с заголовком «Стоит ли мыть машину зимой?»

Вступление для статьи может выглядеть так: «Многие автовладельцы не знают, мыть или нет машину зимой. С одной стороны – стоит смывать с кузова грязь с реагентами, вредными для кузова. С другой стороны – мойка автомобиля зимой может навредить из-за разности температур кузова и воды (тепловой удар). Давайте разберемся, что вредит машине больше».

Содержание статьи

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

Если текст статьи получается большим, стоит разбить содержание на отдельные части и для каждой сделать подзаголовок, как в данном материале на тему, как написать хорошую статью. Для удобства прочтения статьи рекомендуется выделять разделы. Первый уровень раздела заключается в двойные знаки "равно", по мере роста вложенности количество знаков "равно" увеличивается.

Заключение/Выводы

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

Разделы в конце статьи

В конце каждой статьи находятся несколько разделов, цель которых - дополнение статьи разнообразными данными. Используйте следующую последовательность разделов: Примечания, Источники, Литература.

При копировании текстов с различных источников, в обязательном порядке рекомендуется не нарушать авторское право. Все статьи написанные в библиотеке являются авторским трудом редактора, который её написал.
Infobox example.png

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

Infobox

Желательно наличие в статье шаблонов из серии {{infobox}}. Весь список таких шаблонов можно найти на странице Справка:Infobox.

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

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

Code example.png

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

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

Примечания

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

Источники

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

Ссылки/Литература

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

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

См. также


Демки

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

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

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

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

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