← ClaudeAtlas

create-readmelisted

Use when generating or updating professional README.md and CHANGELOG.md files for a project. Covers repository analysis, stack detection, badge generation, structure diagrams, and alignment with Keep a Changelog and SemVer standards. Do NOT use for API-reference docs (use dedicated doc tooling), licenses/governance documents, or internal code documentation (use docstrings/JSDoc). Part of the afonsoft/skills collection.
afonsoft/skills · ★ 2 · AI & Automation · score 78
Install: claude install-skill afonsoft/skills
# 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"). ## When NOT to Use - **API reference docs** — use OpenAPI/Swagger, TypeDoc, Sphinx, or docfx instead. - **License files** — copy the appropriate license text directly (MIT, Apache-2.0, etc.). - **Internal code documentation** — use docstrings, JSDoc, TSDoc, or XML doc comments. - **Architecture diagrams** — use the `drawio-architecture` skill for visual system design. - **Agent harness setup** — use `create-agent-harness` for CLAUDE.md/AGENTS.md and skill scaffolding. ## Process ### Phase 1: Discovery (E