readme

Orchestrate analyze, draft, critique, and verify sub-skills for README quality assurance.

807|122|Updated Mar 8, 2022

Search Tags:#automation #workflow #documentation #readme #quality #review #supervisor

Ready to run

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

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured supervisor workflow for creating high-quality READMEs by coordinating sub-skills that analyze, draft, critique, and verify content, ensuring consistent quality.

Core Features & Use Cases

Orchestrates a multi-step pipeline for README generation, critique, and verification.
Ensures structural integrity, consistent tone, and actionable feedback across modules.
Use Case: apply to a new project to produce a ready-to-publish README that follows project conventions.

Quick Start

Start the end-to-end README supervision by invoking /readme with a module path.

Frequently Asked Questions about readme

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

FAQPage Schema

How do I automate README quality assurance for modules in my repository?▼

Automate README quality assurance by orchestrating a structured pipeline that analyzes, drafts, critiques, and verifies module documentation to produce a finished, ready-to-publish file.

What is the best way to generate a project README that follows existing conventions?▼

The best way to generate a convention-aligned README is using a supervised workflow that stages evaluation and verification, ensuring structural integrity and consistent tone across repository modules.

How does a structured pipeline improve documentation review and critique?▼

A structured pipeline improves documentation review by applying staged evaluation across analysis, drafting, and critique steps, surfacing actionable revisions instead of generic feedback.

Can I use an automated supervisor workflow to verify README structural integrity?▼

Yes, an automated supervisor workflow can verify README structural integrity by running a final verification reporting stage that checks the drafted content against required standards.

Do I need to provide a module path to start automated README generation?▼

Yes, you need to provide a target module path to start the end-to-end supervision, which the workflow then processes through its analysis and drafting stages.

When should I not use an automated documentation workflow for my project?▼

Avoid using an automated documentation workflow when a module lacks sufficient code structure for analysis, as the pipeline depends on parsing repository conventions to draft and verify content.