Формат проекта
Целевая форма — карта компетенций с минимумом текста. Эссе и пересказ теории намеренно вынесены за пределы основного маршрута: они либо ужаты до коротких определений, либо заменены ссылками на первоисточники в материалах листьев.
Из чего состоит сайт
Заголовок раздела «Из чего состоит сайт»- Верхнеуровневая 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в репозитории.
Структура листа
Заголовок раздела «Структура листа»Каждый лист идёт по единому шаблону:
- Lead-параграф — начинается с мнения автора / диагноза проблемы / конкретного случая. От первого лица. Не пересказ description.
:::note[Метаданные листа]— ветвь, путь в графе, SFIA-уровни, приоритет, статус.- Что должен уметь — формулировки уровня «умеет N», привязанные к диапазону SFIA-уровней. Перед списком — короткая проза с приоритизацией («главный навык на уровне LX — …»).
- Материалы — внешние источники с личной оценкой минимум для половины: «по моим наблюдениям, чаще выбирают X»; «если выбирать одну главу — эту».
- Best practices — не больше половины в шаблоне «утверждение/антипаттерн/правильно»; остальное прозой с авторским голосом. Опционально — открывающий параграф с конкретным публичным кейсом (GitLab 2017, Cloudflare 2019, log4shell, Netflix Chaos Monkey, DORA Accelerate).
- Связанные листья — с типом связи (предпосылка / продолжение / альтернатива). Коротко.
- Открытые вопросы — опционально, для листьев в статусе
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.ts | L1-узлы каждой ветви, priorities L1, leaves под L1 |
src/content/docs/sre-{culture,engineering,practices}.mdx | L1 + 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, новые листья и анонсы — в Канале.