Development record
Hand-written text in a rendered page is caught and offered back to its source
Press Release
People will still edit a README by hand. abcd scans every rendered documentation surface for text that has no home: a hand edit to a rendered section, or new prose added beside them. It assesses each piece, says which section of the brief or the how it belongs in, and in the next iteration offers to move it there for the source's owner to accept, from where it renders. Nothing hand-written is discarded unasked: a piece is replaced only once it has been moved into its source or the owner has chosen to drop it.
Why This Matters
Written by the agent on 2026-11-01 from the product thinker's rulings that day (dcn-2611011248594647), restated; the planning interview confirms or rewrites it.
Rendering every documentation surface from its one home (itd-2611011151475128) is only realistic if a hand edit is never lost: people will rewrite their README whatever the convention says. The product thinker ruled on 2026-11-01 that the lane runs in both directions, restated:
- From the sources to the docs, by rendering, always.
- From the docs back to the sources, when a page was adjusted by hand: the hand-written text is caught and offered back to its source rather than overwritten (dcn-2611011248594647).
How it is offered is the agent's proposal for the planning interview: abcd assesses where a piece belongs and puts it to the owner of its source (the product thinker for the brief, the product team or the educators for the how), at a time the open questions below settle.
The lane serves both surfaces people write in: a hand edit to a page rendered from the brief is offered back to the brief, and one to a page rendered from the how (itd-2611011239589823) is offered back to the how.
That second direction is what lets the first be compulsory. A hand edit is a finding with a destination, not drift to be overwritten.
The catch half is already designed: itd-2610031651058674 reports a README part
that has gone stale or been edited by hand and writes nothing, and the part's
marker already carries a checksum over its body
(internal/core/ahoy/readme_marker.go), which tells a hand edit from a stale
render. This intent widens that check from the setup parts to every rendered
section and adds the half no tool has: placing the piece and offering it back.
Links to the record, typed:
- refines itd-2610031651058674: its stale-or-edited check, widened from the README parts to every rendered section, with an offer back instead of a report alone.
- refines itd-2610031348087517's handling of a hand-edited part, which is reported and left as it is; here it is reported, placed and offered back.
- builds on itd-61, whose reconciliation of a human edit to the brief is the step a moved piece goes through once it reaches the brief.
- The rule that a render never discards hand-written text unasked, and holds only the section a piece waits in, is adr-2611011153058085 (proposed).
SOTA
.abcd/development/research/notes/2026-11-01-documentation-sources-sota.md
(review 1, findings 2, 7 and 8): catching a hand edit by regenerating and
comparing is established practice; where AI tools write documentation back,
they propose a change for review and never commit it; no tool or study was
found that drafts the matching edit to a rendered page's source. The lane
follows the established half (catch by comparison) and builds the missing one
as a proposal.
The same note lists "true two-way sync between rendered pages and their sources" as not worth adopting, because a one-way render with a match check gives the same safety. This lane is not that: rendering stays one way, and nothing is ever written back to a source by itself. What the match check alone does not give is the owner's text kept: under a compulsory render, a check that only fails leaves the person to rescue their own words. The offer back is a proposal the owner accepts or declines, which is the pattern the note's finding 8 records.
Mechanism
Prompted (the claim-recording gradient): why the authors expect this to work, as a falsifiable "we expect X because Y" — not the outcome restated. Replace this line with the claim, or with the exact token
None stated.alone on its line to record the claim as considered and declined.
Scope Conditions
Required (the claim-recording gradient): the population, platform, scale, or assumptions this claim holds under, one per top-level bullet —
abcd intent planstamps each with a persistent identity. Replace this line with those bullets, or with the exact tokenNone stated.alone on its line.
Acceptance Criteria
Required (the itd-1 discipline): add at least one Given-When-Then bullet describing the verifiable bar for "shipped" before this draft can be planned.
Open Questions
- When the scan runs. At a verb the person runs (the render, the lint, the release cut) rather than on a schedule, which the person's space rule rules out; which of those, and whether the offer is made at once or at the next session the person opens.
- How a piece is placed. Whether abcd names the section a piece belongs in deterministically (by the section it was edited inside) or a host agent proposes it, and how a piece that fits no section is offered.
- A declined offer. Whether a piece the product thinker neither moves nor drops is offered again or held with a reason; its section stays held either way (adr-2611011153058085).
Typed Links
- built on by
itd-2611011239589823(the how): The lane offers a hand edit to a page rendered from the how back to the how.
Audit Notes
Empty. Populated by intent-auditor when intent moves to shipped/.
Frontmatter
| id | itd-2611011151512956 |
|---|---|
| type | intent |
| lifecycle | drafts |
| severity | minor |
.abcd/development/intents/drafts/itd-2611011151512956-people-will-still-edit-a-readme-by-hand.md
open on GitHub ↗ · commit history ↗
References3
- itd-61A Human Edit To The Brief Cannot Commit Until Its Implied Intents And Principles Are Drawn Out And Reconciledbuilds on
- itd-2610031651058674abcd's check reports README parts that have gone stale, and writes nothingbuilds on
- itd-2611011151475128Every documentation surface is rendered from its one homebuilds on
Referenced by2
- adr-2611011153058085A re-render never discards hand-written text unaskedrelated
- itd-2611011239589823A project's how-to guides and learning material stay current with the productbuilt on by
mentions4
- dcn-26110112485946472026-11-01 — ADOPTED (product thinker, 2026-11-01): abcd-managed repositories move to documentation that holds no prose of its own. What people write lives in the design record (the brief, what the product is and why, its users and roles, with its principles) or the how (how-to guides, and optionally tutorials, exercises and video), and everything else is generated from code and release facts. The rule binds a page section by section as abcd comes to render it; until then a repository's hand-written prose stays where it is. A hand edit to a rendered page is caught and offered back to its source rather than overwritten. Grounds: every-claim-has-one-home already rules a second copy out for the record, and abcd's own README drifted from the brief it restates; two state-of-the-art reviews (2026-11-01) supported explanation in the design record, generated reference, tested how-to and tutorial pages, and one site with separate owners. Recorded in itd-2611011151475128, itd-2611011151512956, itd-2611011239589823 and adr-2611011153058085 (proposed). Reverse by a later decision that names this one; the drafts carry the open questions (rendered or held, where the how lives) that planning settles.
- dcn-26110207201052062026-11-02 — abcd's new website follows the release cut of 2026-11-02 rather than preceding it. The README renders from the brief from its first day, so the brief-sourcing intents itd-2611011151475128, itd-2611011151512956 and itd-2611011239589823 are planned and built first; they carry no acceptance criteria, mechanism or scope yet, and the first holds nine open questions, so each needs the person's planning interview before an automatic plan can run. Pages step 2 of itd-2610142145236613 is built and held unarmed, landing together with the README work and the held identity draft, so the front page and the record's address change once.
- itd-1Every Intent Has Acceptance Criteria; Every Audit Verifies Them
- itd-2610031348087517Setup asks whether abcd keeps parts of the README current, and which