Generate Readme
Generate or refresh a comprehensive, professional README.md for a repository, with...
Install
npx skills add divar-ir/ai-doc-gen --skill generate-readme -g -a claude-code -y- Repository
- divar-ir/ai-doc-gen768
- Category
- Writing
- Updated
- 4mo ago
- License
- MIT
- Context cost
- Lightabout 882 tokens
- Runs scripts
- No, instructions only
What it does
Generate or refresh a comprehensive, professional README.md for a repository, with architecture overview, mermaid and optional C4 diagrams, repository structure, dependencies, and API documentation. Use whenever the user asks to create, write, update, improve, or regenerate a README, project documentation, or a project overview page, even if they just say "document this project" or "this repo needs docs".
Generate README
Transform codebase analysis into a clear, welcoming README.md that helps engineers quickly understand the project.
Workflow
1. Gather analysis data
Check for existing analysis documents in <repo>/.ai/docs/ (structure, dependency, data-flow, request-flow, API analyses). They may have been produced by the analyze-codebase skill.
- If they exist: use them as your primary source, but spot-check key claims against the code, they may be stale.
- If they don't exist: offer to run the
analyze-codebaseskill first (better results, reusable artifacts). If the user declines or wants it quick, explore the codebase directly yourself before writing.
2. Handle the existing README
Ask the user (or infer from their request) whether to incorporate the existing README:
- Incorporate (default when a README exists): read it first; keep useful, still-accurate information, especially manually written content like setup quirks, badges, links, and licensing. Verify claims against the code; the old README may be outdated.
- From scratch: ignore the existing file entirely.
3. Write the README
Include the following sections, in this order, unless the user excludes some. Only use these headlines plus any carried over from the existing README, don't invent extra sections.
