skills.rest
getkyo
getkyoOFFICIAL
Explore all skills by this author →
WebsiteGitHub

readme-analyze-source

Scan module source trees to produce spine candidates and API surface inventories.

807|122|Updated Mar 8, 2022
Search Tags:#documentation#readme#inventory#analyze#clustering#source-code#spine
One-click install
npx skills add https://github.com/getkyo/kyo --skill readme-analyze-source
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-analyze-source
Source: https://github.com/getkyo/kyo/tree/main/.claude/skills/readme-analyze-source
Command: npx skills add https://github.com/getkyo/kyo --skill readme-analyze-source

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about readme-analyze-source

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

FAQPage Schema
How do I analyze source code to generate a README structure and API inventory?▼

Source code analysis for README structuring scans module source trees to produce a spine candidate, callouts, and an API surface inventory. It focuses on scaladoc, public types, and test-case names to shape narrative sections.

What is a spine candidate in documentation, and how does source clustering work?▼

A spine candidate is the central narrative spine extracted from a module's public surface and test signals. Source clustering organizes load-bearing APIs into mental-model clusters to structure README sections.

How do I extract public API surface and callout candidates from Scala source files?▼

Extracting public API surface requires scanning source files in shared/src/main/scala alongside test and docs scaffolds. This identifies load-bearing types, methods, and edge-signal surfaces for callout candidates.

Does this source code analysis tool generate a full README draft automatically?▼

No, this source code analysis tool does not draft a README. It produces five sections of structural outputs—spine, callouts, inventory, clusters, and domain seeds—to feed downstream readme-draft pipelines.

What source directory structure do I need to provide to analyze a module's public surface?▼

You need to provide a module source directory path containing source files in shared/src/main/scala and related test and docs scaffolds. This access allows the scanner to evaluate scaladoc and test-case names.

Related Skills

Explore More Software Engineering Skills→
flext-shflext-sh

rules-src

Enforce coding standards and explicit typing for Python files in the src/ directory.

Official
Intermediate
getkyogetkyo
807

readme-draft

Generate README drafts from spine, callout, and inventory data.

Official
Advanced
lionbenjaminlionbenjamin
15

document

Update READMEs, API docs, and JSDoc/TypeDoc coverage for code changes.

Community
Intermediate
aeoncity-demoaeoncity-demo

Agent Buzz

Extract and cluster AI-agent tweets from X with narrative summaries.

Community
Advanced