Audit CLI help text and generate accurate project README documentation.
npx skills add https://github.com/rahulrajaram/rahulskills --skill readme-doctor
Please help me install this Agent Skill. Skill: readme-doctor Source: https://github.com/rahulrajaram/rahulskills/tree/main/skills/readme-doctor Command: npx skills add https://github.com/rahulrajaram/rahulskills --skill readme-doctor
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.
--help outputs for accuracy and consistency.Run /readme-doctor to audit all CLI help text for consistency and generate a comprehensive README.
High-intent search queries and answers about installing and using this skill.
To validate CLI help text, this Skill audits command names, flags, descriptions, and default values for consistency and verifies them against your code. It checks for accuracy and congruence across your entire command-line interface.
To generate a comprehensive README, this Skill builds a detailed document with required sections like Title, Features, Installation, Quick Start, and CLI Reference. It ensures usage examples accurately reflect your current codebase.
Keeping documentation accurate after CLI updates is best handled by auditing help text and regenerating the README. This Skill verifies documentation against code and generates updated usage examples to ensure congruence.
Yes, this documentation validation tool requires explicit user approval before making any changes. It will not automatically modify your documentation or code definitions without your confirmation.
Yes, you can use this to audit CLI command flags and default values for consistency. It verifies that all help text outputs accurately reflect the underlying code and remain uniform across the interface.
Required sections for generating a README include Title, What is this?, Features, Installation, Quick Start, and CLI Reference. The generated document provides comprehensive coverage of your project's usage.
jeremydhoover-blipGenerate structured CLI help text, usage strings, and flag descriptions.
moonshineTPGenerate README.md files with badges and repository metrics for GitHub.
kbrdn1Detect project type and run ecosystem-specific formatters and linters.
ntluong95Enforce documentation standards for code comments, READMEs, and architectural records.