readme-critique
OfficialCritique README pedagogy to reveal design gaps.
Authorgetkyo
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Provides a rigorous, multi-axial critique of README documentation to assess pedagogy, structure, and design rationale, surfacing catalog-vs-teaching inconsistencies and gaps before verification.
Core Features & Use Cases
- Nine-axis evaluation across composition, domain clarity, API coverage, and cross-API guidance to ensure READMEs teach as well as list capabilities.
- Exemplar-aware critique that compares candidate content against a reference to identify missing topics or misaligned narratives.
- Actionable verdicts and directives that guide rework, ensuring a coherent discovery path and clustered APIs.
Quick Start
Provide the candidate README (and optional exemplar) to run a nine-axis critique and receive a structured report.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: readme-critique Download link: https://github.com/getkyo/kyo/archive/main.zip#readme-critique Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.