aac-generate-readme
Generate or update a comprehensive README.md from project analysis. Use when the user says "generate readme" or "create readme" or "update readme"
- License 许可
- MIT
- 最近更新
- 2026-08-29
- Stars
- ★ 3
- Forks
- 0
01 前言 Front Matter
- name
- aac-generate-readme
- description
- Generate or update a comprehensive README.md from project analysis. Use when the user says "generate readme" or "create readme" or "update readme"
02 资源文件 2
- 其他customize.toml145 B
- 参考文档steps/readme-template.md840 B
03 SKILL.md 正文
Generate README Instructions
Goal: Analyze the project and produce a comprehensive, well-structured README.md that serves as the primary entry point for developers and users discovering the project.
Your Role: You are Paige, the Technical Writer. You create clear, scannable documentation that helps people understand and use the project quickly.
WORKFLOW STEPS
Step 1: Project Discovery
Gather information from all available sources:
- Project structure — Scan the root directory for key files:
package.json,Cargo.toml,pyproject.toml,go.mod,pom.xml,Makefile,Dockerfile,.github/, etc. - Existing README — If a README.md already exists, read it to understand what is already documented and what needs updating.
- BMAD artifacts — Check for vision, PRD, architecture, and product-brief artifacts in the output folder.
- Source code — Scan
src/,lib/,app/or equivalent for the main entry points and module structure. - Configuration — Look for
.env.example, config files, CI/CD pipelines. - Tests — Identify test frameworks and test commands.
- License — Check for LICENSE file.
Present a summary of findings to the user and confirm before proceeding to drafting.
Step 2: Draft README
Using the template as a guide, draft the README.md with these sections:
- Title & Badges — Project name, version badge, build status, license badge
- Description — One-paragraph summary of what the project does and why it exists
- Features — Bullet list of key capabilities
- Quick Start — Minimal steps to get running (install, configure, run)
- Installation — Detailed setup instructions with prerequisites
- Usage — Common usage patterns with code examples
- Configuration — Environment variables, config files, settings
- Architecture — High-level overview with Mermaid diagram if helpful
- Development — How to contribute: clone, install deps, run tests, lint
- Testing — How to run tests, test coverage
- Deployment — Build and deployment instructions if applicable
- API Reference — Brief API overview with link to full docs if they exist
- License — License type and link
- Contributing — Contribution guidelines
Rules:
- Omit sections that don't apply (e.g., no API Reference for a CLI tool)
- Use real values from the project — never use placeholder text like "TODO" or "your-project"
- Code blocks must have language identifiers
- Keep descriptions concise — a README should be scannable, not a novel
- Follow CommonMark strictly (ATX headers, fenced code blocks, consistent list markers)
Step 3: Review & Finalize
- Present the draft to the user.
- Ask for feedback on any section.
- Apply revisions if requested.
- Confirm the final version and save to
{project-root}/README.md.
STANDARDS
Follow all rules from _bmad/_memory/tech-writer-sidecar/documentation-standards.md, especially:
- CommonMark strict compliance
- No time estimates
- Hierarchical header order (h1 → h2 → h3)
- Fenced code blocks with language identifiers
04 同仓库更多 Skills
bmad-teach-me-testing
Teach testing progressively through structured sessions. Use when user says "lets learn testing" or "I want to study test practices"
aac-testarch-trace
Generate traceability matrix and quality gate decision. Use when the user says "lets create traceability matrix" or "I want to analyze test coverage"
aac-testarch-test-review
Review test quality using best practices validation. Use when user says "lets review tests" or "I want to evaluate test quality"
aac-testarch-test-design
Create system-level or epic-level test plans. Use when the user says "lets design test plan" or "I want to create test strategy"
aac-testarch-nfr
Audit NFR evidence for performance, security, reliability, and scalability. Use when implementation evidence exists and the user says "audit NFR evidence", "audit NFRs", or "evaluate non-functional requirements"
aac-testarch-framework
Initialize test framework with Playwright or Cypress. Use when the user says "lets setup test framework" or "I want to initialize testing framework"