Skills
.Work. You
Rest

readme-doctor

Community

Ensure documentation accuracy.

Software Engineering#documentation#validation#cli#readme#help text#code congruence
Authorrahulrajaram
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures that your project's README file is accurate, comprehensive, and up-to-date, and that all command-line interface (CLI) help text is consistent and correct.

Core Features & Use Cases

  • README Generation: Creates a detailed README with required sections like Title, What is this?, Features, Installation, Quick Start, CLI Reference, and more.
  • CLI Help-Text Audit: Verifies that CLI command names, flags, descriptions, and default values are consistent across the entire CLI and accurately reflect the code.
  • Use Case: After updating a CLI tool with new features, use this Skill to automatically generate an updated README and audit all --help outputs for accuracy and consistency.

Quick Start

Run /readme-doctor to audit all CLI help text for consistency and generate a comprehensive README.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 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-doctor
Download link: https://github.com/rahulrajaram/rahulskills/archive/main.zip#readme-doctor

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 223,000+ vetted skills library on demand.