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

readme-verify

Validate READMEs through a five-gate verification workflow.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Three-gate verification for a finalized README: companion script structural check, chunk-by-chunk forward-reference walk, and skim-reader persona walkthrough with a line-grounded spine test.

Core Features & Use Cases

  • Five-gate verification pipeline covering doctest, companion script, forward-reference walk, skim-reader persona, and catalog-detection signals.
  • Detects structural, content, and surface issues; reports findings for remediation.
  • Use Case: QA teams or maintainers ensure READMEs remain accurate and navigable across modules.

Quick Start

Run Gate 0 doctest, then Gate 1 script checks to validate a README against the five gates.

Frequently Asked Questions about readme-verify

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

FAQPage Schema
How do I automate README verification for documentation quality?▼

Automated README verification uses a five-gate workflow to surface structural, content, and surface issues across modules. It validates documentation quality by running doctest checks, companion-script validations, forward-reference walks, skim-reader spine tests, and catalog-detection auditing.

How do I validate README forward references and skim-reader navigation?▼

README forward-reference validation walks through chunks to check integrity, while skim-reader persona walkthroughs perform line-grounded spine tests. These gates ensure documentation remains accurate and navigable, catching structural issues that disrupt the reading flow before publication.

Do I need sbt-kyo-doctest to run README verification checks?▼

Yes, sbt-kyo-doctest is required for Gate 0 results in README verification. Additionally, a source-analysis output is needed to drive Gate 4 catalog-detection decisions, ensuring the module meets the necessary prerequisites for the full five-gate pipeline.

What is the best way to check README companion scripts and doctest compliance?▼

The best way to check README companion scripts and doctest compliance is running Gate 0 for doctest execution followed by Gate 1 script checks. This combination validates structural integrity and code accuracy within the documentation.

What types of README issues can a five-gate verification pipeline detect?▼

A five-gate verification pipeline detects structural, content, and surface issues in READMEs. It identifies broken forward references, failed doctests, companion script structural mismatches, skim-reader navigation failures, and catalog-detection signal discrepancies.

Can I use README verification for modules without companion scripts?▼

README verification applies to modules with READMEs that must pass doctest and companion-script checks. Modules lacking companion scripts may not fully complete Gate 1 validations, limiting the pipeline ability to surface structural issues.

Related Skills

Explore More Content & Communication Skills→
EvitanReltaEvitanRelta

doctest-cmake

Integrate doctest single-header tests into CMake C++ projects.

Community
Intermediate
KamiJeongKamiJeong

docguard-guard

Run DocGuard validation and generate a prioritized documentation quality report.

Community
Advanced
gqf2008gqf2008

baoyu-infographic

Transform content into infographics using 21 layouts and 21 styles.

Community
Advanced
peteski22peteski22
22

validate

Orchestrate validators on modified files and aggregate results into a pass/fail report.

Community
Basic