Forge

docs/ / adr/snippets/adr-related-links-convention.md · branch develop

Соглашение: блок «Связанные ADR»

Чтобы шапка ADR не превращалась в сплошной абзац, связи выносим в таблицу сразу после метаданных (Статус, Дата, Обновлено).

Шапка: Статус, Дата, Обновлено

Поле Правило
Статус Коротко: Accepted, Proposed, Accepted · Implementedбез длинных скобок. Детали реализации → подтаблица ### Снимок реализации (2–4 строки).
Дата Дата принятия ADR.
Обновлено Одна строка: дата последней правки + краткая фраза + ссылка [§ История](#adrNNNN-history), если история не пустая.
Поглощает / Расширяется Оставляем в шапке (происхождение или follow-up), не в истории.

Не дублировать ключ **Обновлено:** несколько раз — хронологию переносим в ## История изменений в конце файла (перед последним --- или после «Отклонённые альтернативы»).

## История изменений

<a id="adr0028-history"></a>

| Дата | Изменение |
|------|-----------|
| 2026-04-08 | … |

Якорь: adr + номер ADR без ведущих нулей в id (adr0028-history для ADR 0028).

Разделитель перед телом: после блока «Связанные ADR» / «Снимок реализации» / Резюме ставим горизонтальную линию ---, затем ## Контекст (или ## Решение / ## Проблема, если контекста нет).

Резюме: блок ## Резюме сразу после «Связанные ADR» (и снимка, если есть) — 3–5 маркеров, суть без якорей §N. Рекомендуется для ADR ≥120 строк; для ≥100 — краткое резюме или stub. Короткие ADR — по желанию.

Superseded: в шапке статус Superseded + ссылка на замену; после метаданных — callout > с указанием 0069 (или иного наследника); исторический текст ниже не переписываем.

Шаблон

## Связанные ADR

| ADR | Роль |
|-----|------|
| [0036](0036-cds-channel-compositor-surface-pipeline.md) | Канал → CDS → композитор → поверхность |
| [0067](0067-graph-backed-surfaces-contract.md) | Контракт семейства graph-backed поверхностей |

Правила

  • Колонка «ADR» — ссылка [NNNN](NNNN-slug.md) или с якорем, если нужен конкретный пункт (#adr0065-p6).
  • Колонка «Роль» — одна короткая фраза: зачем читать, чем ограничивает, что не путать.
  • 3+ связей — почти всегда таблица; 1–2 — допустим маркированный список под тем же заголовком.
  • Старую строку **Связь:** в шапке** при правке убираем (смысл переносим в таблицу).
  • Внешние ссылки (KB, другой репо, сайт) — отдельная строка таблицы с пометкой «вне репо» или подтаблица Вне ADR ниже.
  • Не дублировать оглавление README: в таблице только релевантные соседи, не полный индекс.

Связь с якорями

Кросс-ссылки на пункты внутри ADR — по adr-anchors-policy.md.

View only · write via MCP/CIDE