readme-analyze-existing

Diagnose README files against a source-analysis spine and output structured edit actions.

807|122|Updated Mar 8, 2022

Search Tags:#documentation #analysis #readme #cleanup #skill #actions #spine

Ready to run

npx skills add https://github.com/getkyo/kyo --skill readme-analyze-existing

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: readme-analyze-existing
Source: https://github.com/getkyo/kyo/tree/main/.claude/skills/readme-analyze-existing
Command: npx skills add https://github.com/getkyo/kyo --skill readme-analyze-existing

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about readme-analyze-existing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I diagnose an existing README against a source-analysis spine?▼

Diagnose an existing README by validating its SKILL.md frontmatter against the source-analysis spine, reporting detected issues, and outputting a machine-readable payload of structured actions.

What is the best way to generate a structured action list for documentation cleanup?▼

Generate a structured action list for documentation cleanup by comparing a README to the source spine, producing finite edits like CUT, RELOCATE, RESTRUCTURE, REWRITE-HEADING, REORDER, and ADD-CALLOUT.

Can I use this workflow to separate documentation diagnosis from automated edits?▼

Yes, you can separate documentation diagnosis from automated edits because this workflow produces a spine-consistent diagnosis payload consumed separately by the downstream readme-edit step for safe application.

Does this process validate SKILL.md frontmatter during the README analysis?▼

Yes, the process validates SKILL.md frontmatter during README analysis, checking for structural alignment with the source spine and reporting detected issues before generating the action payload.

Why do I need a machine-readable payload for readme-edit tasks?▼

A machine-readable payload is needed for readme-edit tasks to ensure reproducible cleanup workflows, allowing AI agents and documentation teams to coordinate safe, auditable edits based on the diagnosis.

When should I not use an automated spine alignment workflow for README cleanup?▼

Avoid automated spine alignment for README cleanup when you require manual narrative control rather than finite structured actions, as this process strictly generates machine-readable payloads for automated application.