Памятка для авторов

Недавно мы объявили о том, что в поиске соавторов для платформы "Код на салфетке", почитать об этом можно тут.

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

1. Целевая аудитория

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

2. Публикации на сайт

2.1. Тематика и формат статей

• Обучающий характер материалов, полезные для начинающих программистов, с элементами глубокой технической информации для более опытных.
• Объем текста: от 6000 символов.
• Пример статьи: FastAPI 3. Подключение к SQLAlchemy и генератор сессий

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

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

Пример разделения на блоки:

Пример блока кода:

Пример изображений:

2.3. Уникальность

• Статьи должны быть написаны автором. Допускается публикация на других платформах, но материалы не должны быть заимствованы без разрешения.

2.4. Сроки сдачи

• Статьи должны быть сданы за 3 дня до согласованной даты публикации.

2.5. Код

• Примеры кода должны быть отформатированы по стандартам языка. Для Python это PEP8.
• Тестирование примеров кода остается на усмотрение автора.

3. Публикации в Telegram-канале

3.1. Форматы активностей и рубрик

• Рубрики и активности должны включать опросы, вопросы для обсуждения или полезную информацию для чтения.
• Рубрики должны выходить минимум раз в неделю.

3.2. Уникальность контента

• Материалы должны быть оригинальными, с элементами интерактивности для вовлечения аудитории.
• Запрещается указывать ссылки на ресурсы автора в тексте, но разрешается в изображении рубрики вместе со ссылкой на канал https://t.me/press_any_button.

Пример ссылки на канал в изображении рубрики:

4. Редактирование и рецензирование

• Все материалы проходят ревью в чате авторов, окончательное редактирование выполняется перед публикацией.

5. Авторские права и использование материалов

• Права на статьи остаются у авторов. Редакция может использовать материалы для продвижения ресурса.

6. Вознаграждение

• Вознаграждение не предусмотрено. Авторы могут размещать ссылки на свои проекты и страницы для донатов на сайте.

7. Сроки ответа и взаимодействие с редакцией

• Редакция обязана прочитать материал и либо одобрить его, либо отправить на доработку в срок до 3 дней до публикации.
• Обсуждение правок происходит в чате авторов.

8. Требования к стилю написания

• Стиль выбирается автором, но статья должна быть проверена на наличие пунктуационных и стилистических ошибок перед сдачей.

9. Использование внешних источников и ссылок

• Допускается добавление ссылок на источники, библиотеки и ресурсы, упомянутые в статье.
• Запрещены ссылки на собственные ресурсы автора.

Пример ссылок к статье:

10. Ответственность за фактическую точность

• Авторы несут личную ответственность за достоверность информации. Редакция не может проверять все материалы.

11. Конфиденциальность

• Информация из чата авторов остается конфиденциальной.
• Авторы не могут распространять информацию о подписчиках канала, статистике и другой закрытой информации.

12. Порядок отзыва статей

• Автор имеет право отозвать статью в любое время.
• Перенос публикации возможен при уведомлении за 5 дней до запланированной даты.