readme-critique

To evaluate README documentation for pedagogy and structure gaps, perform a structured analysis across nine axes covering composition, domain clarity, and API coverage to surface design rationale inconsistencies and receive actionable rework directives.

A multi-axis README critique is a structured evaluation across nine axes that surfaces pedagogical and structural gaps before verification. You need it when your README lists capabilities but fails to teach users or explain design rationale effectively.

To compare your README against an exemplar and find missing topics, provide both the candidate and reference documentation to run an exemplar-aware critique that identifies misaligned narratives and content gaps across nine evaluation axes.

Yes, README critique works without a reference exemplar by performing a standalone nine-axis evaluation of the candidate documentation to assess composition, domain clarity, API coverage, and cross-API guidance, returning a consolidated verdict with actionable directions.

The best way to fix a README that catalogs features but does not teach users is to apply a nine-axis critique that reveals catalog-versus-teaching inconsistencies, then follow the resulting actionable verdicts and directives to ensure a coherent discovery path.

Automated README evaluation for design rationale is limited to surfacing gaps across nine structural and pedagogical axes, providing actionable directives for rework rather than generating the corrected documentation or verifying the actual API behavior itself.