Автору

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

Процесс

Чтобы начать участвовать в разработке контента, нужно пройти следующие шаги:

  1. Найти интересующий вас язык тут: https://github.com/hexlet-basics
  2. Разобраться в структуре репозитория на примере выложенных на https://code-basics.com/ru курсов
  3. Начать отсылать пулреквесты

Чем могут помочь наши рекомендации:

  • Структурировать свои знания
  • Выделять смысловые блоки в тексте
  • Определять уровень сложности материала в зависимости от целевой аудитории
  • Объяснять сложные вещи простым языком
  • Оформлять, редактировать и корректировать текст

Список рекомендаций

Перед началом работы над текстом

  • Мы ориентируемся на инфостиль, о котором можно почитать здесь
  • Пройти текстовый курс «Как писать классные тексты»
  • Пройти текстовый курс «Как проектировать классные уроки»

Как проверить готовый текст

Оригинальность текста

В образовательном контенте ценятся тексты, в которых авторы доносят знания своими словами. Вы можете опираться на сторонние источники, но не стоит копировать из них целыми фрагментами. Будет здорово, если оригинальность вашего текста составит от 70% до 100%.

Проверить свой текст можно с помощью этих сервисов:

  • Text.ru — проверяет медленно, но без ограничений
  • Content Watch — проверяет намного быстрее, но до 10000 символов и 3 раза в день

Соответствие информационному стилю

  • Воспользоваться сервисом «Главред» и довести свой текст до 8 — 8.5 баллов
  • Воспользоваться нашим чек-листом:
    • Урок делится на смысловые блоки с подзаголовками
    • Подзаголовки сформулированы так, что отражают подтемы урока
    • Соблюдается правило «Один абзац — это одна мысль»
    • Тема урока раскрыта последовательно:
      • «От знакомого к незнакомому»
      • «От простого к сложному»
      • «От общего к частному»
    • Введение объясняет, как устроен урок, какие темы затронуты и почему эти темы важны
    • Заключение подводит итоги и перечисляет ключевые тезисы

Структура абзацев и предложений

  • Нет монотонных отрывков с одинаковой длиной предложений
  • Нет абзацев со скрытыми запутанными мыслями («Стоит упомянуть», «обратите внимание»)
  • Нет предложений со скрытым действием (отглагольные существительные)
  • Нет предложений со скрытым подлежащим (пассивные, модальные и возвратные глаголы)