菜单
Create or update a README.md for a module, feature, or the project root. Use when the user says 'write a README', 'update the docs', 'document this module', 'add a getting started guide'. Don't use for architecture decisions — use write-adr. Don't use for user stories — use write-spec.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Verify Clean Architecture layer boundaries — domain and application must not import infrastructure. Use when the user says 'check boundaries', 'verify architecture', 'run boundary check', 'validate layers', or after any code change that touches domain or application layers. Don't use for writing new code — use the appropriate create-usecase or add-endpoint skill.
Write an Architecture Decision Record (ADR) capturing a significant technical decision. Use when the user says 'document this decision', 'write an ADR', 'record why we chose X', 'add a technical decision'. Don't use for user stories — use write-spec. Don't use for general documentation — use write-readme.
Create or update a user story with acceptance criteria following the As-a/I-want/So-that format. Use when the user says 'write a user story', 'create a spec', 'define requirements for X', 'add acceptance criteria'. Don't use for architecture decisions — use write-adr. Don't use for README files — use write-readme.
Add a new Gin HTTP endpoint wired to a Use Case following Clean Architecture in a Go project. Use when the user says 'add endpoint', 'create route', 'new API', 'expose X via HTTP', 'add a GET/POST/PUT/DELETE'. Don't use for business logic — use create-usecase-go. Don't use for tests — use write-unit-test-go.
Scaffold a new Use Case following Clean Architecture with TDD in a Go project. Use when the user says 'create use case', 'new service', 'new business operation', 'add X logic', 'implement Y feature'. Don't use for HTTP endpoints — use add-endpoint-gin. Don't use for frontend components — use create-component-mantine or create-component-mui.
Write a unit test for a Use Case or domain entity using Go's standard testing package with table-driven tests. Use when the user says 'write test', 'add tests', 'test this', 'TDD', 'cover X with tests'. Don't use for HTTP handler tests — use add-endpoint-gin for the handler, then test the use case. Don't use for integration tests with real databases.
| name | write-readme |
| description | Create or update a README.md for a module, feature, or the project root. Use when the user says 'write a README', 'update the docs', 'document this module', 'add a getting started guide'. Don't use for architecture decisions — use write-adr. Don't use for user stories — use write-spec. |
| metadata | {"skill_type":"micro"} |
README.md) or specific module (src/{module}/README.md).AGENTS.md to extract the project's semantic commands (dev, test, build, lint).AGENTS.md, not raw tool commands.docs/specs/ for details.docs/specs/adr/.AGENTS.md (e.g., npm run dev) not tool-specific commands (e.g., npx ts-node src/index.ts) — semantic commands survive tooling changes.docs/specs/ — link to it instead. Duplicated content drifts and confuses.User says: "Write a README for the billing module."
Actions:
src/billing/README.md.AGENTS.md → commands are npm run dev, npm test, npm run build.npm run dev, npm test -- --filter billing.docs/specs/billing/domain-model.md.docs/specs/adr/ADR-003-stripe-integration.md.Result: src/billing/README.md created with 4 sections, all links verified.
Stale commands → README shows commands that don't work → Re-read AGENTS.md and package.json (or equivalent) to verify current commands before writing.
Missing architecture docs → No docs/specs/ content to link to → Write the README with a placeholder link and note: "Architecture docs pending — see write-spec skill."
README too long → Exceeded 200 lines → Extract detailed sections into docs/ files and replace with links. The README is an index, not an encyclopedia.
write-adr — for recording architectural decisionswrite-spec — for user stories with acceptance criteria