readme-analyze-existing
OfficialDiagnose readmes and generate clean action plans.
Authorgetkyo
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Diagnose an existing README against a source-analysis spine and produce a structured action list consumed by readme-edit. This ensures a reproducible cleanup workflow by separating diagnosis from application.
Core Features & Use Cases
- Produces a spine-consistent diagnosis by comparing the README to the source spine.
- Generates a finite set of actionable edits (CUT, RELOCATE, RESTRUCTURE, REWRITE-HEADING, REORDER, ADD-CALLOUT) for the readme-edit step.
- Useful for documentation teams and AI agents coordinating safe, auditable edits.
Quick Start
Run the readme-check evaluation on a target README to produce a structured action list.
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-analyze-existing Download link: https://github.com/getkyo/kyo/archive/main.zip#readme-analyze-existing 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.