Skip to content

README: lead with agent problems, not document types - #16

Merged
emafriedrich merged 1 commit into
mainfrom
readme-agent-problems
Oct 1, 2026
Merged

emafriedrich merged 1 commit into
mainfrom
readme-agent-problems

Conversation

@emafriedrich

Copy link
Copy Markdown
Owner

Summary

  • Reorders the README around five concrete problems agents cause (guessing rules, stale docs, can't tell draft from settled, silent ambiguity resolution, undocumented legacy rules) paired one-to-one with what closes each one — before any DR/RFC/Spec terminology.
  • Moves the DR/RFC/Spec breakdown into "The vocabulary, if you want it," opening with why each type exists (checkable approval, explicit not-yet-true, proven-not-declared) instead of leading with definitions.
  • Folds the standalone "Why knowledge drifts" section into the matching problem/fix pair instead of repeating it.
  • No change to the concrete example, quick start, how-it-works, limits, or comparison sections — only their position and the framing around them.

Goal: make the value legible to a semi-senior/senior reader who has never heard of an RFC or a DR, without losing the concrete evidence (the real decision record, the field numbers) that makes the pitch credible.

Test plan

  • Checked no other file links to a now-removed anchor in README.md
  • Read-through for tone/accuracy

🤖 Generated with Claude Code

Agents don't know your rules, invent them when missing, and the invention
quietly stands as truth whether or not it's written down. The README now
names that and four more agent-specific problems up front, paired with
what closes each one, before any DR/RFC/Spec vocabulary. The vocabulary
section moves down and opens with why each type exists (checkable
approval, explicit not-yet-true, proven-not-declared) instead of leading
with definitions.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@emafriedrich
emafriedrich merged commit a18ef51 into main Oct 1, 2026
1 check passed
@emafriedrich
emafriedrich deleted the readme-agent-problems branch October 1, 2026 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant