Сложность:Теги:
Структура README
Что и в каком порядке должно быть в README — чтобы новый человек запустил проект за 5 минут.
docsreadmeonboarding
Открыть
Начальный15-30 мин
API-документация
OpenAPI/Swagger, описание endpoints, примеры запросов и ответов, ошибки.
docsapiopenapi
Открыть
Средний30-60 мин
Changelog и версионирование
Keep a Changelog + SemVer: что писать, когда бампать, как объявлять breaking.
docschangelogsemver
Открыть
Начальный15-30 мин
Runbook для инцидента: шаблон
Симптомы → first response → escalation → проверки → восстановление → пост-мортем. Живой документ, не отчёт.
docsrunbookincident
Открыть
Средний30-60 мин
ADR-практика: lifecycle, что туда писать, что НЕ
Когда писать ADR (architectural, не каждый PR), формат, lifecycle (proposed/accepted/superseded), как сделать живым, что НЕ ADR.
docsadrarchitecture
Открыть
Средний30-60 мин
5 из 5