| name | judge-facing-readme |
| description | Use only at the end of an exam task to write a short submission-oriented README that tells graders what was built, how to run it, how it was verified, what was intentionally omitted, and what would come next. Not for marketing, changelogs, or long architecture essays. |
| origin | ECC-derived |
Judge Facing README
Source Lineage
Primary inherited sources:
legacy/ecc-source/agents/doc-updater.mdlegacy/ecc-source/commands/update-docs.mdlegacy/ecc-source/commands/save-session.mdlegacy/ecc-source/commands/verify.mdlegacy/ecc-source/skills/verification-loop/SKILL.mdlegacy/ecc-source/agents/tdd-guide.mdlegacy/ecc-source/agents/code-reviewer.md
Inherited methods:
- documentation must match the codebase reality
- run and verify sections must come from actual commands, not assumptions
- include testing evidence, not just a list of commands
- summarize what worked, what failed, and what comes next
- report risks clearly and avoid padded narrative
When To Use
Use this after implementation and tests are done or intentionally capped.
Expected Outputs
- a short README draft
- clear run instructions
- a verification section
- a testing evidence section
- explicit tradeoffs and limitations
- one short next-steps section
Required Sections
- overview
- what works
- how to run
- how to verify
- test evidence
- assumptions and tradeoffs
- known limitations
- next hour
Build It From Evidence
- derive run commands from the real project entrypoint
- derive verify commands from the checks you actually ran
- state which critical paths those checks cover
- state what was not tested and why
- state omitted work explicitly
- if something failed or was skipped, say so plainly
Output Format
- Overview:
- What works:
- How to run:
- How to verify:
- Test evidence:
- Tradeoffs and assumptions:
- Known limitations:
- If I had one more hour:
Tone
- direct
- concrete
- easy to scan in under five minutes
What Not To Do
- do not write release notes
- do not describe platform vision
- do not hide unfinished work
- do not pad the README with ecosystem or setup theory
