Skip to content

docs(design): rewrite the efficacy benchmark design for its reader - #1845

Merged
braboj merged 2 commits into
mainfrom
docs/efficacy-design-rewrite
Sep 24, 2026
Merged

braboj merged 2 commits into
mainfrom
docs/efficacy-design-rewrite

Conversation

@braboj

@braboj braboj commented Sep 24, 2026

Copy link
Copy Markdown
Collaborator

Part of #1767. This is the design-doc rewrite from the owner's section-by-section review on 2026-09-24, after the two PRs it depended on (#1843, #1844).

What changes

Readability

  • Plain words, with jargon defined at first use. "Pre-registered" is gone, "trim" and "confound" are defined, and units are spelled out.
  • Tables for settings, bullets for steps, and a one-line "Why" after each rule.
  • Mermaid diagrams for the verdict rule (§1.1), the build trial (§4.1) and the scoring pipeline (§5).
  • A worked example up front (§1), and a plain overview of tariff with the coffee example and a definition of SKU (§2.1).
  • Every subsection numbered; §4 no longer has a lone 4.1.

History out of the body

  • Every dated decision and rejected alternative moves to one decision log (§10): date, decision, why, issue.
  • Derivations (K = 3 limits, judge noise, the budget figures, the hidden-suite validation) move to an appendix (§11).
  • §12 "Round 2" dissolves. Its rules that still hold move to §3, §5 and §6.

Content brought up to date

  • Five arms, their budgets and trial names (§3). Round 3 starts anew.
  • Eight contrasts, matching report.CONTRASTS (§6.1).
  • The judge as it runs: anchored primaries, three judgings per tree, and the control fixture. The second (Claude) judge reads the control only (§5.6, §5.7).
  • Only the tools and probes the code runs (§5.2, §5.3). Mutation score, cohesion and pylint's refactoring checks are listed as not measured.
  • The security checks now, and the round-3 plan to make security and data protection primary (§5.8). Their margins are still to be fixed before round 3's first trial, per Measure security and data protection as primary dimensions in the efficacy benchmark #1767.
  • The confounds table gains the controls the code already has: judge noise, the anchored scale, withdrawn metrics, lost trials, spec changes between rounds, and hybrid's vendored templates. Row 1 now describes the refusal the harness actually makes.
  • The budget from measured round 1–2 figures (§8).

Code comments that cited §1.1, §11 or §12 now cite §1.3, §3.3 and §6.1. Comments only; no behaviour changes.

Checks

The report self test passes (83/83), as do reuse (9/9) and generate_arm. Smoke: 33, 0 failed. sync.py --check passes. Conformance: 0 failed. I also checked every line outside tables and code fences: none is over 88 characters.

For the reviewer

Changelog

No entry. This is the repository's own design document, and nothing a consuming project reads.

🤖 Generated with Claude Code

braboj and others added 2 commits September 24, 2026 12:55
The owner read the design section by section and found it dense, full
of jargon, and out of date after round 3 was set to start anew. This
rewrites it in plain language:

- plain words, with jargon defined at first use
- tables for settings, bullets for steps, a one-line reason after a rule
- Mermaid diagrams for the verdict rule, the trial and the scoring
  pipeline
- a worked example and an overview of `tariff` up front
- every subsection numbered, and no section with a lone subsection
- round history, dates and rejected alternatives moved into one decision
  log (§10), and the derivations into an appendix (§11)

Content now matches the code and the decisions:

- five arms and eight contrasts
- the anchored judge, read three times, and the control fixture that
  checks it
- only the tools and probes that actually run
- the confounds the code already controls
- a budget from measured round 1–2 figures
- "Arm C runs", "18 runs" and "the evidence check is the only check"
  are gone

Section 12 dissolves into §3, §5, §6 and §10. Code comments that cited
§1.1, §11 or §12 now cite §1.3, §3.3 and §6.1.

Part of #1767.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The adherence and web-quality bullets, the report's record, the judge-noise
paragraph, one long sentence and two long table cells become sub-bullets,
lists and shorter cells. The context-engineering link moves out of the
decision log to a note under it.

Part of #1767.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@braboj
braboj merged commit 1ff1edd into main Sep 24, 2026
1 check passed
@braboj
braboj deleted the docs/efficacy-design-rewrite branch September 24, 2026 10:00
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