Перейти к содержимому

Формат проекта

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

  • Верхнеуровневая mermaid-схема ветвей — в README.md на GitHub.
  • Интерактивный паук (главная страница) и branch-views — рендерятся на сайте из src/data/roadmap.ts.
  • Содержимое каждого листа — на сайте по адресу /The-Way-of-SRE/leaves/<branch>/<slug>/; исходники в src/content/docs/leaves/<branch>/<slug>.md.
  • Шаблон листа — src/content/docs/leaves/_template.md в репозитории.

Каждый лист идёт по единому шаблону:

  1. Lead-параграф — начинается с мнения автора / диагноза проблемы / конкретного случая. От первого лица. Не пересказ description.
  2. :::note[Метаданные листа] — ветвь, путь в графе, SFIA-уровни, приоритет, статус.
  3. Что должен уметь — формулировки уровня «умеет N», привязанные к диапазону SFIA-уровней. Перед списком — короткая проза с приоритизацией («главный навык на уровне LX — …»).
  4. Материалы — внешние источники с личной оценкой минимум для половины: «по моим наблюдениям, чаще выбирают X»; «если выбирать одну главу — эту».
  5. Best practices — не больше половины в шаблоне «утверждение/антипаттерн/правильно»; остальное прозой с авторским голосом. Опционально — открывающий параграф с конкретным публичным кейсом (GitLab 2017, Cloudflare 2019, log4shell, Netflix Chaos Monkey, DORA Accelerate).
  6. Связанные листья — с типом связи (предпосылка / продолжение / альтернатива). Коротко.
  7. Открытые вопросы — опционально, для листьев в статусе draft. Допускается «я не разобрался с X» как приглашение к PR.

Подробные правила заполнения шаблона — в файле src/content/docs/leaves/_template.md. Astro игнорирует _-префиксированные файлы, поэтому шаблон не публикуется как страница, но виден в GitHub UI.

Контент пишется от первого лица как наблюдение профессионала: «я регулярно вижу», «по моим наблюдениям», не «команды должны». Мнения — через наблюдение, не через категоричный выбор: «я вижу, что чаще выбирают X», не «я бы выбрал X».

В каждом листе обязательны: один конкретный пример (публичный incident или авторское наблюдение), одно явное мнение, одна граница применимости.

Терминология: устоявшиеся англицизмы SRE (SLI/SLO, postmortem, runbook, on-call, blameless) пишутся латиницей курсивом без склонения. Явные кальки (decision log, shift transition, sitrep cadence) переводятся. Запрещены гибриды через дефис («blameless-принцип», «high-severity incident», «pull-based модель»).

Полные правила и определения живут в двух разных местах:

  • Глоссарий — публичный артефакт читателя. Что термин значит: определение, перевод, категория, ссылки на листья, источник. Если в листе встречается термин — он сначала ищется и при необходимости добавляется в глоссарий, прежде чем уйти в текст листа.
  • inventory/style-guide.md — внутренний документ контрибутора. Голос, структура секций, запрещённые AI-паттерны, чеклист готовности.
  • inventory/terminology.md — внутренний документ контрибутора. Как переводить термины: 4 категории (оставляем латиницей / переводим / двойная форма / спорные), правила графики.
ФайлЗа что отвечает
src/data/roadmap.tsL1-узлы каждой ветви, priorities L1, leaves под L1
src/content/docs/sre-{culture,engineering,practices}.mdxL1 + L2 inventory концептов (как nested list под каждым L1)
src/content/docs/leaves/<branch>/<slug>.mdСодержимое одного листа
inventory/overlaps.md (GitHub)Решения по пересечениям между ветвями (рабочий артефакт)

Подробнее про инварианты — в Методологии.

  • Поправки в листьях — PR с одним атомарным изменением в одном файле.
  • Изменения в структуре графа (L1 в src/data/roadmap.ts и L2 inventory в sre-*.mdx) — обязательно сверка с Методологией и inventory/overlaps.md в репозитории.
  • Новые листья — создаются строго по шаблону src/content/docs/leaves/_template.md в src/content/docs/leaves/<branch>/<slug>.md, с обновлением навигации (astro.config.mjs + src/data/roadmap.ts).
  • ОбсуждениеЧат в Telegram, новые листья и анонсы — в Канале.