writing-use-cases
为后端系统创建带有序列图的结构化用例文档。在记录API端点、服务交互、事件流或系统行为时使用。响应"记录此用例"、"为X端点创建用例"、"编写流程文档"或"解释X功能如何工作"等请求时触发。
📖 中文导读:为后端系统创建带有序列图的结构化用例文档。在记录API端点、服务交互、事件流或系统行为时使用。响应"记录此用例"、"为X端点创建用例"、"编写流程文档"或"解释X功能如何工作"等请求时触发。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: writing-use-cases description: Create structured use case documentation with sequence diagrams for backend systems. Use when documenting API endpoints, service interactions, event flows, or system behaviors. Triggers on requests like "document this use case", "create use case for X endpoint", "write flow documentation", or "explain how X feature works".
Writing Use Cases
Create use case markdown files that document backend flows with mermaid sequence diagrams.
Discovery Workflow
- Identify entry point - Find the controller/handler for the endpoint
- Trace the flow - Follow method calls, service interactions, external calls
- Find events - Look for message publishing (SNS, Kafka, RabbitMQ, etc.)
- Map state transitions - Identify entity state changes
- Note validations - Document validation rules and constraints
Output Structure
# {Feature Name} Use Case
## Overview
{1-2 sentences: what this use case does and when it's triggered}
## Flow
{mermaid sequence diagram - see references/mermaid-patterns.md}
## Key Points
- **Entry Point:** `{HTTP method} {path}` ([`{ControllerName}`]({relative-path}))
- **Request Model:** [`{DtoName}`]({relative-path})
- **State Transition:** {from} → {to}
- **Event:** `{EventName}` published to {destination}
- **Validation:** {key validation rules}
Output File
- Use the
docs/{use case name}-use-case.mdas output file location (DEFAULT). - Ask the User, if the default is fine or another location should be used.
Writing Guidelines
- Keep overview concise (1-2 sentences)
- Use relative links to source files
- Include all actors and systems in the diagram
- Group related operations with
Note overblocks - Use
alt/elsefor conditional flows - Document both success and error paths when relevant
Mermaid Patterns
See references/mermaid-patterns.md for sequence diagram syntax and examples.