healthlog уже переехал на канон 3, а переименование секции я внёс правкой записи версии 3 задним числом — то есть переписал текст, по которому он ехал. Посылка «ни один проект на каноне 3 не стоит» была ложной, решение ШШШ отменено. Запись версии — черновик ровно до первого переехавшего проекта. После этого она история, и любое изменение канона заводит новую версию, даже если меняется одно слово. Проверять дёшево: grep '"canon"' по живым проектам. Дорого обратное — проект, повышенный по тексту, которого больше не существует, невоспроизводим. Запись версии 3 восстановлена дословно (Разработка | Tooling), переименование уехало в версию 4. jellybit, стоящий на каноне 2, прочтёт обе записи подряд и заведёт Разработка, чтобы через шаг переименовать; в шаг версии 3 добавлена оговорка «едешь сразу на 4 — заводи Готово последней и не переставляй дважды». «Готово» переехало вниз, и порядок секций стал каноническим. Достигнутое копится: через год этой секции больше, чем всех остальных вместе, и стоя первой она отодвигает за экран то, ради чего роадмап открывают чаще всего. Порядок проверяет roadmap_lint, переставляет check --fix — вместе с содержимым секций, потому что двигать десяток строк руками это работа, на которой ошибаются. Чужую секцию перестановка не трогает вовсе: её место в порядке неизвестно. Индексы позиций считаются из самого кортежа: ACHIEVED был 0 и стал 3, хардкод пережил бы перестановку молча и сломал бы close. Обкатка нашла два дефекта оформления, оба порождённые самой перестановкой. Отбивка нужна и перед заголовком — сдвиг блоков ставит два заголовка вплотную. Удаление строки индекса оставляет две пустые подряд, и пустоты копятся. Проверка оформления теперь сверяется с самим нормализатором, а не своим набором условий: два описания одного правила разъедутся, и check начнёт молчать о том, что --fix правит. CANON_VERSION = 4 в docs.py, примеры .pm.json в canon.md и skeletons.md. DECISIONS тема 26 (ЭЭЭ, ЮЮЮ, ЯЯЯ, следствия 98–100). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
22 KiB
Журнал версий канона
Одна запись на версию. Проект знает свою версию из docs/.pm.json; canon upgrade идёт по записям снизу вверх от версии проекта до текущей и делает то,
что в них названо.
Правило записи: что добавилось, что переехало, что удалено, что сделать
проекту. Без последнего пункта запись бесполезна — по ней и работает
upgrade.
Версия — целое число. Обратной совместимости у канона нет: есть «приведён» и «не приведён».
Версия 4 — 2026-08-04
Одна секция роадмапа переименована, и вместе с именем расширен её смысл; достигнутое переехало вниз. Плюс общий словарь для трёх мест канона, которые говорят про одну тему разными словами. Раскладка не меняется, файлов не прибавляется.
Что переехало: секция роадмапа Разработка → Сопровождение (англ.
Tooling → Operations). Прежнее имя называло слишком много: роадмап
весь про разработку, и секция с таким именем не отличалась от остальных
ничем.
Что добавилось:
- Смысл секции расширен. Было «инструмент и процесс», стало «чем держат
проект: инструмент, процесс, эксплуатация». Метрики, логи, инфраструктура,
выкладка и дежурство — сюда же. Расширение не косметическое: английское
Operationsпри узком смысле обещало бы эксплуатацию, а внутри лежал бы линтер. - Общий словарь трёх мест — canon.md, раздел «Сопровождение и
эксплуатация». Сопровождение — всё, чем держат проект; эксплуатация — его
часть, работа системы на проде.
ROADMAP.md, секцияСопровождение— план работ;architecture.md, раздел «Эксплуатация» — как устроено сейчас; эксплуатационный проход ревью — оптика проверки. Слить их в одно слово нельзя: они отвечают на разные вопросы. Слово «поддержка» не употребляется вовсе — в нём слышится помощь пользователю. - Граница с возможностями проходит по тому, кто наблюдает. «Приложение сообщает о своём состоянии» — возможность приложения, её место среди прочих целей. «Дежурный видит состояние на одном экране» — сопровождение. Одни и те же метрики попадают в разные секции роадмапа, и это верно.
- Порядок секций стал каноническим, и
Готовопереехало вниз:Запланировано|Направления|Сопровождение|Готово. Достигнутое копится — через год этой секции больше, чем всех остальных вместе, — и стоя первой она отодвигает за экран то, ради чего роадмап открывают чаще всего. Порядок проверяетtasks.py check, переставляетcheck --fix. - Заголовок секции отбивается пустой строкой с обеих сторон. Прежде
проверялась только строка после заголовка; перестановка секций двигает целые
блоки, и два заголовка оказываются вплотную. Правит
check --fix.
Что сделать проекту:
- Переименовать заголовок секции в
docs/tasks/ROADMAP.md:## Разработка→## Сопровождение(или## Tooling→## Operations, если индекс английский).check --fixэтого не сделает: регистр канонической секции он правит сам, а чужую секцию только называет ошибкой — смысл за человеком. - Поправить поле
- **Секция:**в файлах целей, которые в ней лежат. Порядок именно такой: сперва заголовок, потомpython3 tasks.py check --dir docs/tasksпокажет расхождение поимённо. - Перечитать состав секции: цели про выкладку, метрики, логи и инфраструктуру,
если они лежали в
Направленияхза неимением места, переезжают сюда. - Прогнать
python3 tasks.py check --dir docs/tasks --fix: он переставит секции роадмапа в канонический порядок (Готовоуедет вниз вместе со всем содержимым) и поправит отбивку заголовков. docs/.pm.json:"canon": 4.
Версия 3 — 2026-08-04
Роадмап стал состоянием проекта, а не очередью работ: цель — возможность приложения, задача — шаг к ней, достигнутое из роадмапа не исчезает. Плюс род работы, раздел «Затрагивает» и новое умолчание профиля ревью. Раскладка меняется в одном файле, но переименование и смена секций тянут за собой ссылки, поэтому шаги делаются одним заходом.
Что добавилось:
- Род работы — тег
kind:<род>в мете задачи, словарь закрыт:feature|fix|chore|research. Обязателен у задачи, у цели запрещён.sprint takeбез него отказывает,checkо пропаже напоминает замечанием. Определение — canon.md, разделtasks/; смысл и причина, почему тегом, — в SKILL.md скиллаtasks, раздел «Род работы». - Раздел «Затрагивает» в теле задачи — перечень границ, которых изменение касается (эндпоинт, таблица и миграция, формат на диске, публичный тип). Как и критерии приёмки, требуется к взятию в спринт, а не к заведению.
- Секции роадмапа — четыре вместо двух и канонические, в отличие от
секций беклога:
Готово(достигнутые цели строкой с датой, без ссылки на файл),Запланировано(очередь значима),Направления(очереди нет),Разработка(инструмент и процесс, не возможности приложения). Английский вариант —Done|Planned|Directions|Tooling, один язык на весь индекс. Переименованию проектом не подлежат: у каждой свой смысл, и в первую пишет самclose;tasks.py checkпроверяет состав. - Форма заголовка записи — по типу: задача отвечает на «что нужно сделать»
и пишется глаголом в неопределённой форме («Не отбрасывать молча лишние
символы»), цель — на «что приложение будет уметь», идея просто называет, о
чём она.
checkсчитает заголовки не в форме действия и печатает число в блоке здоровья. Годность формулировки — не машине: её смотрит новый агентtask-form(форма записи, только чтение), а язык текста —doc-wording. - Заголовки секций — с прописной, после заголовка пустая строка, во всех
индексах. Написание канонических секций и отбивку правит
check --fix; он же сводит написание секции в мете файла с заголовком индекса. - Язык проектных текстов — language.md, общий дом для документов канона, задач, решений ADR и записок разведки: информационный стиль (глагол вместо отглагольного существительного, активный залог, факт вместо оценки, стоп-слова, параллельность), таблицы англицизмов и жаргона и то, что из стиля отброшено намеренно. Проектных файлов не добавляет и раскладку не меняет — это правила письма, а не новый слот.
- Умолчание профиля ревью сменилось — это не раскладка, но проектный текст
под него уже написан.
standardстал рабочим умолчанием: миграция схемы, публичный контракт и инвариант ступень больше не поднимают,wideозначает новое понятие или структурную единицу. Подраздел «Триггеры профиля» вdocs/review.mdостаётся на месте, но его содержимое надо перечитать.
Что переехало: docs/tasks/PLAN.md → docs/tasks/ROADMAP.md; достигнутая
цель — из небытия в секцию Готово: close <цель> --implemented удаляет файл, но
оставляет строку с датой. Прежде роадмап отвечал только «что осталось», и
половину его вопроса вели прозой руками. Вместе с
файлом переименован ключ конфига tasks.plan → tasks.roadmap и токены
команд: --index plan → --index roadmap, init --plan-sections →
--roadmap-sections, init --plan → --roadmap. Старый ключ в
docs/.pm.json не игнорируется молча — tasks.py останавливается и называет
переименование.
Что удалено: тип [epic]. Он был зонтиком между целью и задачами; зонтиком
стала цель, а слишком крупный шаг дробится на шаги помельче под ней. Ноль
употреблений на 97 записей двух живых проектов.
Что сделать проекту:
git mv docs/tasks/PLAN.md docs/tasks/ROADMAP.md.- Починить ссылки на прежнее имя:
grep -rn 'PLAN\.md' docs/ CLAUDE.md— заголовок самого файла («# План» → «# Роадмап»), строка вdocs/tasks/BACKLOG.md, упоминания вdocs/passport.mdи в телах задач. docs/.pm.json: ключtasks.plan, если он там был, — вtasks.roadmap.- Проставить род работы живым задачам:
python3 tasks.py check --dir docs/tasksперечислит те, у кого его нет. Задним числом весь беклог не переоформляется — род нужен к взятию, так что порядок такой: сперва то, что берётся в ближайший спринт, остальное по ходу переоценки. - Дописать раздел «Затрагивает» — тем же порядком и по той же причине: сперва набор спринта, остальное по мере того, как задача попадает в работу.
- Перечитать «Триггеры профиля» в
docs/review.md: строки вида «миграция →deep» теперь дублируют умолчание с обратным знаком. Оставить там только то, что для этого проекта считается новым понятием и правилом идентичности, — и убрать остальное, иначе проект возвращает себе прежнюю частоту полного набора уточнением. - Переименовать секции роадмапа:
порядок→Запланировано,темы→Направления; завестиГотовопервой иРазработкапоследней (порядок секций поменялся в версии 4 — если едешь сразу на неё, заводиГотовопоследней и не переставляй дважды). Прозаические разделы вроде «Что уже пройдено», которые велись руками, разложить: звенья — строками вГотово(дата, слаг, что стало возможно), обоснование очереди оставить прозой вЗапланировано. Любой##в индексе проверка считает секцией, и теперьcheckназывает чужую секцию ошибкой. - Переформулировать цели ответом на «что приложение будет уметь»: не
«Работа со слиянием», а «Исход слияния не зависит от порядка доставки».
Свойство поведения — законная цель. Цель, которая не про приложение
(процесс, инструмент), переезжает в
Разработка. [epic], если он в проекте заводился: это либо цель, либо набор задач под общей целью.checkназовёт его неизвестным типом.- Прогнать
python3 tasks.py check --dir docs/tasks --fix: он поднимет написание канонических секций, поставит отбивку после заголовков и сведёт секцию в мете файлов с заголовками индексов. Секции беклога проект переименовывает сам — их имена он выбирал, и трогать их скрипт не вправе. - Переписать заголовки задач в форму действия — по мере того, как задача
попадает в работу, а не «заодно»:
checkпечатает их число, аtask-formпредложит формулировки на замену пачкой. - Прочитать language.md — и ничего не переписывать задним числом. Правила языка применяются к тому, что пишется и правится сейчас; сплошная вычитка старых документов стоит дороже, чем даёт.
docs/.pm.json:"canon": 3.
Версия 2 — 2026-08-03
Шапка записи ADR — мета-блоком общей формы, и у статуса появился объявленный дом. Раскладка не менялась: правка касается одного шаблона.
Что добавилось: поле - **Статус:** в шапке docs/adr/template.md —
заменено на ADR-… либо устарело, у активной записи поля нет. Правило
«старая запись получает статус» было и раньше (canon.md, adr/),
но места под него шаблон не отводил: каждая запись изобретала своё, а колонка
«Статус» таблицы adr/README.md брала его оттуда, где он у каждого свой.
Что переехало: поля Дата и Источник в шаблоне стали жирными
(- **Дата:**, - **Источник:**) — та же форма, что у меты задачи и у записи
журнала дефектов: поле на строку, имя жирным.
Что удалено: ничего.
Что сделать проекту:
- Привести
docs/adr/template.mdк скелету версии 2 (skeletons.md, разделdocs/adr/template.md). - В существующих записях
docs/adr/ADR-*.md: жирным поля шапки; если статус записан прозой или заголовком — перенести его полем- **Статус:**в шапку и сверить с колонкой «Статус» таблицы вdocs/adr/README.md. docs/.pm.json:"canon": 2.
Версия 1 — 2026-08-03
Первая версия. Проект любой прежней раскладки приводится к ней скиллом canon
в режиме adopt, а не upgrade.
Что вводится: раскладка целиком — см. canon.md.
Что сделать проекту, который приходит из свободной раскладки:
docs/.pm.jsonс{"canon": 1}и путём миграций, если БД есть.- Скелет канона целиком; незаполненное — одной честной строкой.
docs/specs/разобрать: поведение — вopenspec/specs/, обзор — вdocs/architecture.md, знание о чужих системах — вdocs/research/. Дубли capability удалить, сверив поимённо.docs/plan.md→docs/tasks/PLAN.md, шаги плана — целями в «порядок».BRIEF.md→docs/passport.md.docs/backlog/→docs/tasks/.docs/review-journal.mdилиdocs/review/journal.md→docs/review.md, плюс раздел настройки конвейера.docs/drafts/растворить: идея → задача[idea], намеренный отказ → ADR, порядок работ →PLAN.md.docs/review-brief.md, если заводился, удалить: его разделы разошлись по документам канона.conventions.md→conventions/,local-research.md→research/.- Завести
docs/security.mdс периметром первой строкой иdocs/adr/. - В
CLAUDE.md: severity рядом с каждым инвариантом; семантика гейта (чем краснеет безусловно, где логи, чего в нём нет и кто тогда гоняет дорогое); имя основной ветки; запреты с путями; гдеtestdataи куда писать временное; что считается необратимым; общий станок; ориентир по размеру спринта. Убрать раздел «Процесс», если он пересказывает пайплайн. - В
openspec/config.yamlоставить только нужды генерации и ссылки. - Добавить шаг
docs.py checkв гейт проекта.
Копии правил в шаблонах, которые версия 1 уносит в проект — их правка в каноне обязана появляться здесь отдельной версией:
| Что копируется | Дом определения |
|---|---|
форма записи журнала дефектов в docs/review.md |
av-dev-pipeline/skills/review-pipeline/references/review-journal.md |
правило заведения ADR в docs/adr/README.md |
canon.md, раздел adr/ |