Skills
.Work. You
Rest

readme-analyze-source

Official

Extract spine-ready insights from source code.

Software Engineering#documentation#readme#inventory#analyze#clustering#source-code#spine
Authorgetkyo
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Analyzes a module's source to produce a spine candidate, callout list, and an API surface inventory for use by readme-draft and readme-analyze-existing. This skill does NOT draft a README, evaluate existing READMEs, or verify outputs.

Core Features & Use Cases

  • Spine candidate: produces the central narrative spine from the module's public surface and test signals.
  • Callout candidates: identifies notable edge-signal surfaces to surface in README guidance.
  • API surface inventory: enumerates load-bearing types and methods for curriculum planning.
  • Section clusters: organizes APIs into mental-model clusters to structure README sections.
  • Running-domain seeds: suggests realistic case domain structures to demonstrate in examples.

Quick Start

Provide a module source directory path to analyze and run this skill to generate a spine candidate, callouts, and an API inventory.

Dependency Matrix

Required Modules

None required

Components

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-source
Download link: https://github.com/getkyo/kyo/archive/main.zip#readme-analyze-source

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.