create-readme
Create README and CHANGELOG
Overview
Transforms a raw repository into a well-documented project by generating professional README.md and CHANGELOG.md files based on empirical evidence from the codebase, git history, and configuration files. Every claim in the generated documentation must be traceable to a file, commit, or config in the repository.
When to Use
-
When a project lacks a README or CHANGELOG.
-
When existing documentation is outdated, incomplete, or inconsistent.
-
Before shipping a new version to ensure the changelog is up to date.
-
When restructuring a project and the existing documentation no longer reflects the architecture.
-
When onboarding new contributors and the README doesn't answer "what is this, how do I run it, how do I test it?"
-
User asks or mentions this skill in English (e.g., "use /create-readme", "run create-readme").
-
O usuário pede ou menciona esta skill em português (ex.: "use /create-readme", "execute create-readme").