docs(rules): every implementation round carries a docs ticket to merge - #407
Open
hugolytics wants to merge 1 commit into
Open
docs(rules): every implementation round carries a docs ticket to merge#407hugolytics wants to merge 1 commit into
hugolytics wants to merge 1 commit into
Conversation
Documentation is the part of this system that goes stale without anything failing -- the same shape the profile-prose contract test exists to catch, but with no test behind it. A round that changes behaviour and leaves the docs describing the old one produces a confidently wrong reader. So the round is not done when the code is: it carries a ticket to bring the docs up to what changed, explained according to best practices the ticket states rather than assumes, and that ticket lands in the same PR. A sonnet subagent picks it up, which keeps the cost of the rule low enough that it survives contact with a busy round. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem
Documentation is the part of this system that goes stale without anything failing. That is the same shape
test_timeboxing_profile_contract.pyexists to catch in the persona prose — the model reads it, believes it, and produces a confidently wrong plan — except the docs have no test behind them. A round that changes behaviour and leaves the docs describing the old one produces the same confidently wrong reader, human or agent.The rule
Hugo's, added to
CLAUDE.md: an implementation round is not done when the code is. It carries a ticket to bring the docs up to what changed, explained according to best practices the ticket states rather than assumes, and that ticket lands as part of the same PR. A sonnet subagent picks it up, which keeps the cost low enough that the rule survives contact with a busy round.Provenance
This is Hugo's own edit, written in the shared root checkout and left uncommitted. Committing it is what makes it reach the other sessions — a project rule sitting uncommitted in a working copy that a dozen sessions share governs none of them, and per
shared-checkout-mutatesit was at real risk of being committed under unknown authorship or wiped by agit checkout --. The only change I made to the text is a trailing newline.Carried to a worktree rather than committed on the root checkout, because a
checkout -bthere moves every peer's tree.Review
CLAUDE.mdrule (governs every session) rather than a skill or a ticket template🤖 Generated with Claude Code