Руководство по оформлению записей на сайте

Далее слова «запись» и «пост» считаются синонимичными.

Миниатюра записи

Для каждой записи желательно наличие изображения в шапке.1 Изображения должны быть размера 770х270. Предпочтительнее flat-стиль. Для фотографий формат jpeg (progressive), для рисунков png с целью минимизации размера. Картинки не должны нарушать копирайты.

На миниатюре размещать какие-либо надписи крайне нежелательно!

Заголовки

Заголовок должен передавать суть записи, из него должно быть понятно о чём она. Длина не ограничивается. Для каждого заголовка должен быть задан корректный перевод на английский и прописан как постоянная ссылка записи. Не допускаются ссылки транслитом или кириллицей. В тексте используются заголовки от третьего уровня (h3) и ниже (h4, h5).

Пример короткой цитаты прямо в тексте.

Текст

В качестве кавычек используются французские «ёлочки». Буква «ё» применяется на усмотрение автора. При прочих равных лучше её использовать. Правила оформления перечней (если не открывается, смотрите тут) обязательны к прочтению. Короткие цитаты в тексте тегом pullquote, длинные blockquote. Внешние ссылки обязательно открывать в новой вкладке (target=’_blank’), для этого достаточно поставить соответствующую галочку у первой ссылки. Обращение «вы» пишем с маленькой буквы.

Учтите, что машинописные кавычки "" в тексте автоматически заменяются на «ёлочки», но всегда рассчитывать на это не стоит.

Тире, короткое тире, дефис и минус.

Общие правила:

— Знак минуса — «-» — ставится ТОЛЬКО в математических формулах и уравнения, его вполне можно заменить дефисом: «-».
— Короткое тире — «–» — ставится в диапазонах чисел: 1–5, 9–15 и т. д. Пробелами НЕ отбивается.
— Тире — «—» — ставится в предложениях по правилам русского языка: «Вот эта фраза — пример такого использования». ВСЕГДА отбивается пробелами, пробел после тире имеет смысл делать неразрывным: « » в HTML.
— Дефиc ставится в остальных случаях, также согласно правилам русского языка: «кое-какой». Пробелами НЕ отбивается.

Совет: При наборе текста имеет смысл на месте тире ставить три машинописных дефиса (тех, что на стандартной клавиатуре) с отбивкой пробелами, на месте короткого тире — два дефиса, и после написания заменять автоматически тройной дефис с пробелами на « — », а затем двойной дефис на «–». Порядок замен важен. Сейчас на сайте настроена автозамена трёх дефисов на длинное тире.

Источник

У каждого поста должен быть указан источник со ссылкой:

  • Для новостей:

    Источник: <a href=’ссылка_на_статью-источник’ target=’_blank’>название_сайта-источника</a>

    (пример);

  • Для переводов:

    Перевод статьи <a href=’ссылка_на_статью’ target=’_blank’>«название_статьи»</a>

    (пример).

Кроме того, в статьях, в которых ведётся повествование от 1 лица, первая строка должна быть такого же формата, как в этом или этом (а лучше всего — как в этом) примерах.

Рубрики и метки

Рубрика у поста всегда одна и наиболее узко подходящая. Например, если это и статья, и перевод, то нужно выбирать перевод. Метки должны помогать фильтровать посты, т.е. нести смысловую нагрузку. Всегда нужно стараться использовать существующие и добавлять новые, только если недостаточно текущих. После добавления новых меток или рубрик обязательно задать для них перевод на английском в меню редактирования. Пример плохих меток: подборка, видео. Пример хороших меток: java, для начинающих.

Публикация ссылки ВКонтакте

У каждого поста автоматически прописываются OpenGraph теги. Картинка подцепляется из миниатюры, заголовок из названия, описание из первых символов текста. Если ВКонтакте уже закешировал информацию про пост, можно использовать инструмент для очистки кеша. Публиковать ссылки на посты желательно с подцепленными тегами т.е. без дополнительной прикреплённой картинки. Если у поста на сайте миниатюры нет (не подходит ни одна, либо все с копирайтами), то есть трюк. Можно добавить миниатюру к статье, затем вставить ссылку, которую ВКонтакте закеширует, затем удалить из поста миниатюру.

Check-list перед публикацией

— (для редакторов) Проверить, что у поста выставлен правильный автор (Типичный программист).
Проверить орфографию, инструмент умеет проверять страницы по ссылке.
— Выставить корректную рубрику.
— Прописать метки.
— Скорректировать дату и время поста.
— Проверить внешние ссылки в статье (в т.ч. с картинок).
— Поставить тег «Далее».
— Проверить, что в посте ВКонтакте корректно подцепились OG-теги.
— Дать прочитать текст хотя бы еще одному члену команды.

Алексей Михайлишин специально для «Типичного программиста»

  1. Проверка сносок