getkyo/kyo

readme-verify

Three-gate verification for a finalized README: companion script structural check, chunk-by-chunk forward-reference walk, and skim-reader persona walkthrough with a line-grounded spine test.

原文の言語: 英語

readme

Write or review a high-quality README that serves engaged readers, not audit checklists. Cuts bloat by default; only adds when the addition closes a question the reader is actually asking.

原文の言語: 英語

readme-analyze-existing

Diagnose an existing README against the source-analysis output and produce a structured action list (CUT/RELOCATE/RESTRUCTURE/REWRITE-HEADING/REORDER/ADD-CALLOUT) consumed by readme-edit. Splits its work into 0(a)(i) source-only draft, 0(a)(ii) anchored…

原文の言語: 英語

readme-analyze-source

Analyze a module's source code to produce a spine candidate, callout list, and API surface inventory for use by readme-draft and readme-analyze-existing.

原文の言語: 英語

readme-critique

High-judgment whole-document review for shape, pedagogy, and design-rationale. Catches the catalog-vs-teaching, composition-vs-enumeration, running-domain-vs-ad-hoc failure modes that readme-verify's gates pass on. Runs between draft and verify.

原文の言語: 英語

readme-draft

Draft a README from a source-analysis output (spine + callouts + API inventory). For new READMEs or full rewrites. Length scales with API surface; never invents content not in the inventory.

原文の言語: 英語

readme-edit

Apply a structured action list (CUT/RELOCATE/RESTRUCTURE/REWRITE-HEADING/REORDER/ADD-CALLOUT) to a README. Mechanical only; no diagnosis. Em-dash removal must rewrite the sentence, not substitute punctuation.

原文の言語: 英語