README Generator Skill

The problem

Writing README files is a tedious chore that often leads to outdated or incomplete documentation. Developers frequently struggle to organize setup steps, environment variables, and project structures into a format that is actually useful for other contributors.

What it does

• Generates structured, copy-ready Markdown based on project features and tech stacks.
• Creates specific sections for installation, configuration, and API documentation.
• Protects sensitive data by automatically replacing real secrets with safe placeholders.
• Identifies and flags missing information rather than inventing fake commands or dependencies.
• Offers three distinct output modes: Minimal, Standard, and Developer-focused.

Why this beats prompting it yourself

General AI prompts often hallucinate npm commands, assume specific runtimes like Python or Node, and invent license types you never agreed to. This skill enforces strict accuracy rules, ensuring every command, dependency, and feature is grounded in your actual project data without fabricating URLs or requirements.

Use cases

• Generating a comprehensive Standard README for a new open-source repository.
• Creating a technical Developer README with architecture and API details.
• Sanitizing internal project notes into a clean, public-facing README.
• Auditing project documentation to identify missing setup or configuration steps.

Known limitations

Will not invent commands or URLs if they aren't provided in the source info. Requires project details like tech stack and features to produce high-quality output.