rc-readme
SolidCreates or updates a project README by analyzing the real codebase, then rewriting README.md with accurate, evidence-based content — or guides writing/improving a README by hand with templates and guidance matched to audience and project type (open source, personal, internal, config). Use when generating a README from scratch, refreshing an outdated one, syncing docs after features land, or drafting/reviewing a README manually. Do not use for API reference files (use rc-openapi or rc-postman), changelog generation, or editing source code.
Install
Quality Score: 79/100
Skill Content
Details
- Author
- rodolfochicone
- Repository
- rodolfochicone/rc-project
- Created
- 1 months ago
- Last Updated
- 2 weeks ago
- Language
- JavaScript
- License
- MIT
Bundled in these plugins
Similar Skills
Semantically similar based on skill content — not just same category
writing-project-readme
Use when explicitly invoked to write or fully rewrite a project README that must cover tech stack, architecture, features, and service description in a single document — readable by non-engineers (PM, design, ops, domain experts) as well as developers. Triggers on requests like "write the README", "redo README.md based on the whole project", "make a comprehensive README everyone can understand". Skip for one-section edits, badge tweaks, or generating a CHANGELOG.
readme-writer
Write, generate, overhaul, or fix a project's README.md (or any "readme", repo front page, or top-level project documentation). Use this skill whenever the user wants to create or improve a README, document a repo, or figure out how to present a codebase to readers — covering libraries and packages, CLI tools, research/ML repos, web apps, services, and developer tooling. Trigger even when the user only says things like "document this project", "write docs for my repo", "make a readme", or points at a codebase and asks how to present it, even if the word "README" never appears.