Files
clickstream-data-platform/docs/adr/0011-component-docs.md
T
ddadminandClaude Fable 5 cf1c6c4636 docs(orders): спека превращена в принятый живой набор architecture/orders
Зачем: датированная спека — событие истории, а устройство компонента — живой
документ; большое полотно плохо грузится и агентом, и человеком (ADR 0011).

Что: вычитание #84 слито с переустройством формы: набор
docs/architecture/orders/ — индекс README и семь файлов по частям устройства
(нарезка по правилу «семь плюс-минус два»); датированные файлы удалены,
ссылки перенацелены, AGENTS.md дополнен правилом подпапки. Приёмка
владельцем #88 пройдена, черновой статус снят из README.

Проверка: холодная сверка миграции свежим тредом — потерь решений нет;
обход относительных ссылок набора — битых нет.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-17 22:05:52 +03:00

3.3 KiB

ADR 0011. Устройство компонента — связный набор живых документов

Дата: 16 августа 2026 года. Статус: принято.

Решение

Детальное устройство крупного компонента живёт в docs/architecture/ подпапкой: индекс README.md — целевая картина и указатели — и отдельный файл на каждую часть устройства. Имена — слаги без дат; набор правится по мере постройки, как и остальные справочники этой папки.

Первый такой набор — заказы бэкенда, собранный из спеки этапа 3 и спеки приёма. Датированные файлы 2026-08-16-orders.md и 2026-08-16-order-ingestion.md удалены, ссылки на них перенацелены; историю держит git.

Почему

Спека и базовая документация — разные жанры, а файл был один. Спека — событие: проект изменения с датой в имени, замерзающий после приёмки. Но собранная спека заказов сразу стала и детальным устройством сервиса — тем документом, по которому этап 3 будут строить и с которым потом сверяться. Живому устройству дата в имени врёт, а замерзать ему нельзя.

Один большой документ плохо читается обоими читателями. Агент, строящий судьбу заказа, вынужден везти в контексте формат провода и приём; человек листает пятьсот строк ради одного раздела. Индекс с файлами по частям даёт обоим одно и то же: загружается только нужная часть, а карта целого — один экран.

Долговечно только то, что в git. Резолюции развилок живут в трекере, а трекер долговечным хранилищем не считается. Поэтому решения — вместе с отклонёнными вариантами при каждом правиле — лежат в файлах набора; ссылки на тикеты остаются вежливостью, не записью.

Следствия

  • docs/specs/ остаётся событиям: мастер-спека и спека генератора живут как есть; переводить ли их в живую форму — отдельное решение, когда встанет.
  • Раздел «Структура» в AGENTS.md обновлён тем же коммитом.
  • Ссылки из ADR 0008 и 0010, мастер-спеки, спеки генератора, исследования формата и доки хранилища перенацелены на набор.