Files
orchestrator/docs/_templates/06-adr-ADR-NNN-slug.md
claude-bot 5e60543232 docs(standards): pipeline docs standard — manifest + templates + ADR-naming
Создан golden source структуры номерных документов work item (ORCH-52b, слой 1
эпика ORCH-52). Docs-only: STAGE_TRANSITIONS / QG_CHECKS / check_* / схема БД не
трогаются (AC-6).

- docs/_standards/PIPELINE_DOCS.md — манифест «стадия→агент→документ→категория→
  гейт→frontmatter machine-key» (сверен с src/stages.py и src/qg/checks.py) +
  раздел ADR-naming. Манифест документирует поведение гейтов, источник истины
  остаётся код (ADR-001 §D2); честно различает machine-verdict (12/13/14/15/17)
  и информационные (00/08/10/16) доки; под-гейты ребра deploy-staging→deploy
  отмечены как врезки в advance_stage.
- docs/_templates/* — 15 копируемых скелетов; машинные доки несут точный
  frontmatter-ключ из _parse_* (verdict/result/deploy_status/staging_status/
  security_status/post_deploy_status).
- Точки-ссылки: CLAUDE.md, docs/architecture/README.md; запись CHANGELOG.
- tests/test_orch_52b_docs_standard.py — TC-01..TC-20 структурные проверки;
  полный pytest tests/ зелёный (1177 passed).

Refs: ORCH-075

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-09 13:25:39 +03:00

44 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# ADR-NNN: <Заголовок решения>
> **Шаблон ADR.** Скопируй в `docs/work-items/<plane-id>/06-adr/ADR-NNN-<kebab-slug>.md`.
> `NNN` начинается с `001`, инкремент при нескольких ADR в задаче. `<kebab-slug>` — нижний
> регистр, слова через дефис. Сквозное (cross-cutting) решение дополнительно дублируй в
> `docs/architecture/adr/adr-NNNN-<kebab-slug>.md` (4-значная глобальная нумерация).
> См. `docs/_standards/PIPELINE_DOCS.md` §4.
Work Item: **ORCH-NNN** — <короткое описание>
Стадия: **architecture**
Сквозная регистрация: **`docs/architecture/adr/adr-NNNN-<slug>.md`** (если решение
кросс-каттинговое; иначе — «N/A, локальное решение задачи»).
## Статус
Proposed <!-- Proposed | Accepted | Superseded by ADR-… -->
## Контекст
<Какую проблему решаем; факты, сверенные с кодом (`src/…`); почему «как есть» не годится.>
## Решение
### Сводка
<Суть выбранного решения в одном-двух абзацах.>
### D1 — <название аспекта решения>
<Конкретное решение по аспекту, инварианты, привязка к FR/AC.>
### D2 — <название аспекта решения>
<…>
## Альтернативы
- **<альтернатива>** — отвергнуто: <почему>.
## Последствия
- **+** <положительный эффект>
- **** <издержка / приятый компромисс + митигейшн>
- **Откат:** <как полностью откатить изменение>
## Ссылки
- BRD: `docs/work-items/ORCH-NNN/01-brd.md`
- TRZ: `docs/work-items/ORCH-NNN/02-trz.md`
- Acceptance: `docs/work-items/ORCH-NNN/03-acceptance-criteria.md`
- Сверено по коду: `src/…`