readme-draft

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

807|122|Updated Mar 8, 2022
One-click install
npx skills add https://github.com/getkyo/kyo --skill readme-draft
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-draft
Source: https://github.com/getkyo/kyo/tree/main/.claude/skills/readme-draft
Command: npx skills add https://github.com/getkyo/kyo --skill readme-draft

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates turning a structured source-analysis output into a ready-to-edit README draft, ensuring a consistent curriculum-driven structure.

Core Features & Use Cases

  • Convert spine, callouts, and API inventory into a cohesive README.
  • Enforce the prescribed section order and teaching-oriented section naming.
  • Produce a complete document that can be further refined by a human author.

Quick Start

Generate a complete README draft from the spine, callouts, and inventory provided for a Skill unit.

Frequently Asked Questions about readme-draft

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

FAQPage Schema
How do I generate a README from source analysis data?▼

To generate a README from source analysis data, you provide structured spine, callouts, and API inventory outputs to automate the drafting of a ready-to-edit Markdown document. The tool converts these structured inputs into a cohesive, curriculum-driven README.

How do I structure documentation to follow curriculum-first teaching rules?▼

To structure documentation with a curriculum-first approach, the draft enforces five specific rules: a defined opening, logical composition, cluster sections, cross-API teaching, and strategic callout placement. This ensures the README teaches concepts progressively rather than just listing features.

What's the best way to convert an API inventory into Markdown documentation?▼

The best way to convert an API inventory into Markdown documentation is to process it alongside spine and callout data to produce an export-ready draft. This ensures API references are integrated into cluster sections with cross-API teaching context.

Can I automatically draft docs from structured callouts and spine data?▼

Yes, you can automatically draft docs from structured callouts and spine data. The system takes these specific analysis outputs and generates a complete, coherent Markdown document following prescribed section order and teaching-oriented naming conventions.

Do I need a pre-existing source-analysis output to generate a README draft?▼

Yes, you need a pre-existing source-analysis output containing spine, callouts, and an API inventory to generate a README draft. The tool operates specifically on these structured Skill unit inputs to map them into a complete Markdown document.

Can I edit the generated Markdown README after it is drafted?▼

Yes, you can and should edit the generated Markdown README after it is drafted. The tool produces a ready-to-edit document that enforces structural rules but is designed to be further refined by a human author before final export.