Правила оформления статей для проекта «ITBases.RU»

Оглавление

Большинство инструкций должно иметь свое оглавление, которое состоит как минимум из трех пунктов.

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

Следующие пункты оглавления должны быть на Ваше усмотрение. Сюда можно отнести пункты непосредственно связанные с раскрытием темы статьи. Если это установка и настройка какого-то сервера, то можно так и назвать пункты:

  • Установка сервера
  • Настройка сервера

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

Если же это обычная заметка, текст которой не превышает 1 500 символов, то оглавление для такой статьи необязательно.

Текст

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

Статья должны быть уникальной, авторской. Количество символов в статье должны быть не менее 1 500 без учета пробелов. Текст должен быть как можно более грамотней. То есть, содержать минимум пунктуационных и орфографических ошибок.

Текст должен иметь логическую цепочку, понятным для пользователя. Необходимо чтобы пользователь читал инструкцию, заметку и понимал, о чем идет речь. Чтобы он быстро смог воспроизвести все то, что описано в статье. Чтобы у пользователя осталось минимум вопросов после прочтения.

Заголовки содержания должны быть выделены жирным начертанием. Введение и заключение статьи должно быть кратким, то есть, без «воды».

Скриншоты

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

Размеры скриншотов не должен превышать 640×480 пикселей. На каждой картинке должен находиться водяной знак нашего проекта, взять его можно ниже:

Для темных картинок:

Водяной знак ITBases.RU для темных картинок
Водяной знак ITBases.RU для темных картинок
Водяной знак ITBases.RU для светлых картинок
Водяной знак ITBases.RU для светлых картинок

Краткое описание статьи, ключевые слова

Каждая статья должна сопровождаться кратким описанием. Описание должно быть не более 160 символов. В нем должна быть описана краткая суть инструкции/заметки.

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

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

Информация об авторе

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

Пожалуйста, авторизуйтесь чтобы добавить комментарий.
  Подписаться  
Уведомление о