菜单
Generate or update a repository README with startup instructions and a Mermaid architecture diagram. Use when creating a README, updating project documentation, onboarding new contributors, or when the user mentions README, startup guide, or architecture overview.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Guide PMs and designers in creating comprehensive wireframes and mockups that accurately represent all backend API responses and data states. Use when creating wireframes or mockups for new features.
Summarize board, backlog, or sprint status for stakeholders with risks, blockers, and delivery confidence. Use for weekly PM updates and planning checkpoints.
Write high-quality tickets from product requests, incidents, or discovery notes. Use when drafting or refining implementation-ready work items.
Check whether README documentation should be updated when code changes affect setup, usage, commands, configuration, environment variables, workflows, or user-visible behavior. Use when making changes that may invalidate existing README content or require new documentation.
Generate weekly commit summaries and categorize work. Use for weekly retrospectives or progress reviews.
Verify product behavior with Cursor browser automation by driving real UI flows, capturing failures, and turning findings into actionable repro steps or follow-up tests. Use when the user asks for browser automation, in-browser verification, UI smoke checks, or manual flow testing in Cursor.
| name | update-readme |
| description | Generate or update a repository README with startup instructions and a Mermaid architecture diagram. Use when creating a README, updating project documentation, onboarding new contributors, or when the user mentions README, startup guide, or architecture overview. |
Generate or update a comprehensive README by analyzing the repository's code, config files, and directory structure.
Task Progress:
- [ ] Step 1: Analyze repository
- [ ] Step 2: Draft startup instructions
- [ ] Step 3: Generate architecture diagram
- [ ] Step 4: Assemble and write README
- [ ] Step 5: Verify
Scan the repo to gather context. Check for:
| Signal | Files to Check |
|---|---|
| Language/runtime | package.json, pyproject.toml, go.mod, Cargo.toml, Gemfile, *.csproj |
| Package manager | package-lock.json, yarn.lock, pnpm-lock.yaml, poetry.lock, uv.lock |
| Containerization | Dockerfile, docker-compose.yml, .devcontainer/ |
| CI/CD | .github/workflows/, .gitlab-ci.yml, Jenkinsfile |
| Environment | .env.example, .env.template, .envrc |
| Existing docs | README.md, docs/, CONTRIBUTING.md |
| Entry points | main.ts, index.ts, app.py, main.go, src/ |
| Config | tsconfig.json, vite.config.*, next.config.*, webpack.config.* |
If a README already exists, preserve any sections the user has manually written (badges, license, contributing guidelines) and only update the startup and architecture sections.