guide

Руководство по оформлению постов для песочницы проектов.

Ниже приведены рекомендации по написанию постов для победителей «Песочницы проектов» для различных площадок «Типичного программиста».

Посты для сайта «Типичный программист»

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

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

Заголовки

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

Текст

Текст должен содержать описание проекта и может включать любую связанную с ним информацию. Прежде всего, необходимо наличие следующих элементов:

  • История о том, какая проблема побудила к созданию проекта.
  • История реализации самого проекта (от выбора технологий до текущей реализации).
  • Описание технологий, на которых создан проект.
  • Описание будущих целей относительно данного проекта.
  • Ссылка на работающий проект или его прототип.

Можно также разместить в тексте контакты автора проекта, ссылки на сайт проекта / группу ВКонтакте проекта и информацию о том, какая помощь требуется проекту.

Далее идут стилистические требования по оформлению текста.

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

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

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

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

Совет:

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

Check-list перед отправкой

  • Проверить орфографию, инструмент умеет проверять страницы по ссылке.
  • Проверить внешние ссылки в статье (в т.ч. с картинок).
  • Проверить заголовки: содержание основного заголовка и уровни заголовков в тексте (h3, h4, h5).
  • Проверить, что в качестве кавычек везде используются французские «ёлочки».
  • Проверить написание тире, дефисов и минусов.
  • Проверить наличие в содержании текста 5 элементов, перечисленных выше.
  • Проверить, что картинка размера 770×270 или больше (с примерным сохранением пропорций)

Посты для групп «Типичный программист» и «/dev/null»

Заголовки

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

Текст

Текст должен содержать описание проекта и может включать любую связанную с ним информацию. Прежде всего, желательно наличие следующих элементов:

  • История о том, какая проблема побудила к созданию проекта.
  • История реализации самого проекта (от выбора технологий до текущей реализации).
  • Описание будущих целей относительно данного проекта.
  • Ссылка на работающий проект или его прототип.

Можно также разместить в тексте контакты автора проекта, ссылки на сайт проекта / группу ВКонтакте проекта и информацию о том, какая помощь требуется проекту.

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

Посты для Твиттера

Текст должен содержать краткое объявление о проекте со ссылкой сайт проекта/группу ВКонтакте проекта либо на пост о проекте на сайте «Типичный программист» / в группе «Типичный программист» / в группе «/dev/null».

При желании можно прикрепить картинку со скриншотам (-ами) проекта и/или логотипом проекта (при наличии).

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

P.S.

Минимальный объём для статьи на сайт — 500 слов.

Статью для сайта не надо присылать в HTML. Достаточно прислать doc-файл либо ссылку на Google Document.

Посты для групп необходимо предложить соответственно в «Типичный программист» и в «/dev/null» и прислать ссылки на них.

Перед отправкой материалов:

  1. Проверьте их в Орфографе.
  2. Проверьте их в Типографе.
  3. Проверьте в Microsoft Word (если используете).

Денис Краснов специально для «Типичного программиста»