Как мы делаем уроки

Пайплайн

1. 1Спецификация

   Человек описывает, чему урок обязан научить: цель, понятия, которые нельзя пропустить, тип практики и то, что явно вне рамок.

2. 2Черновик

   Черновик пишется по этой спецификации. Его структура проверяется машиной: урок без блоков теории, практики или подсказок не проходит.

3. 3Валидация

   Автоматические проверки следят за структурой, графом зависимостей и тем, что ни один текст не захардкожен вне файлов переводов.

4. 4Техническая проверка

   Утверждения проверяются на фактическую точность. Упрощать можно; утверждать заведомо ложное — нет.

5. 5Перевод

   Каждый урок переводится по фиксированному глоссарию, чтобы терминология была одинаковой во всём курсе.

6. 6Публикация

   Урок выходит, только если все проверки пройдены. Если они падают, падает сборка — битый контент до сайта не доезжает.

Что проверяется автоматически

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

Ограничения, честно

Уроки пишутся с машинной помощью и затем проверяются человеком. Значит, ошибки возможны, и мы предпочитаем сказать об этом, а не делать вид, что их нет. Нашли — сообщите, правка вносится в урок, а не прячется.