安装命令
npx skills add https://github.com/danhvb/my-ba-skills --skill 'Use Case Documentation'🇨🇳中文介绍
用例文档技能
目的
描述用户如何与系统交互以实现特定目标。用例从以用户为中心的角度捕获功能需求，通常用于瀑布式或混合式开发环境，这些环境需要在实施前进行详细规范说明。
使用时机
- 复杂的交易系统（银行、医疗保健）。
- 当必须严格定义特定的替代流程和错误处理时。
- 法规遵从性要求详细文档。
- 弥合业务需求与技术功能规范之间的差距。
用例剖析
关键要素
- 用例名称 : 动词-名词短语（例如，“提取现金”）。
- ID : 唯一标识符（例如，UC-ATM-01）。
- 参与者 : 谁进行交互？（主要：发起者；次要：外部系统）。
- 描述 : 目标简要摘要。
- 前置条件 : 在开始之前必须满足什么条件？（例如，“用户已登录”）。
- 触发条件 : 什么启动了用例？（例如，“用户点击提取”）。
- 主成功场景（基本流程） : “理想路径”步骤。
- 替代流程（扩展） : 变体或错误路径。
- 后置条件 : 在可靠完成后，什么条件为真？（例如，“余额已更新”）。
- 业务规则 : 逻辑关联。
用例模板
示例：在 ATM 提取现金
ID : UC-ATM-01 名称 : 提取现金 主要参与者 : 银行客户 次要参与者 : 银行系统（后端）
描述 : 客户通过 ATM 从其支票账户提取实体现金。
前置条件 :
- ATM 有足够的现金。
- ATM 在线。
- 客户拥有有效的卡片和 PIN 码。
触发条件 : 客户插入卡片。
主成功场景（理想路径） :
- 客户插入借记卡。
- 系统验证卡片可读性。
- 系统提示输入 PIN 码。
- 客户输入 PIN 码。
- 系统与银行系统验证 PIN 码。
- 系统显示应用程序菜单。
- 客户选择“提取现金”。
- 系统提示输入金额。
- 客户输入金额（例如，$100）。
- 系统检查每日限额和账户余额。
- 系统授权交易。
- 系统分发现金。
- 系统打印收据。
- 系统弹出卡片。
- 用例结束。
替代流程 :
-
A1: PIN 码无效（在第 5 步）
- 系统显示“PIN 码无效”消息。
- 系统提示重新输入 PIN 码。
- 客户重新输入 PIN 码。
- 从第 5 步继续。
- 约束 : 如果 PIN 码无效 3 次，执行 A2（锁定卡片）。
-
A2: 锁定卡片（来自 A1）
- 系统显示“因尝试次数过多，卡片已锁定”。
- 系统保留卡片。
- 用例结束。
-
A3: 资金不足（在第 10 步）
- 系统判定账户余额 < 请求金额。
- 系统显示“资金不足”。
- 系统提示输入较低金额或取消。
- 客户输入新金额。
- 从第 10 步继续。
-
A4: ATM 现金不足（在第 10 步）
- 系统检查内部现金分发器 > 请求金额。
- 系统检测到现金不足。
- 系统显示“无法分发全额现金”。
- 用例结束。
后置条件 :
- 用户账户因提取金额而扣款。
- 创建交易日志。
- 更新现金库存。
用例与用户故事对比
| 特性 | 用例 | 用户故事 |
|---|---|---|
| 关注点 | 系统交互步骤 | 用户价值/目标 |
| 详细程度 | 高（流程、错误） | 低（对话起点） |
| 格式 | 文档/结构化文本 | 卡片/便利贴（谁、什么、为什么） |
| 生命周期 | 随时间更新/维护 | 完成后丢弃/归档 |
| 适用场景 | 瀑布式/混合式/复杂系统 | 敏捷/Scrum |
最佳实践
- 使用主动语态编写 : “系统验证 PIN 码”（而不是“PIN 码被验证”）。
- 保持系统界面中立 : 不要说“用户点击右上角的蓝色按钮”。说“用户选择选项”。
- 聚焦目标 : 不要迷失在技术细节中（例如，“系统发送 JSON 数据包”）。
- 关联异常 : 确保处理每一条错误路径。
工具
- Lark Docs / MS Word : 标准格式化。
- Visual Paradigm / UML 工具 : 用于用例图。
- Gherkin : 可以将用例流程转换为 Gherkin 场景以进行测试。
每周安装量
0
代码仓库
首次出现
1970年1月1日
安全审计
🇺🇸English
Use Case Documentation Skill
Purpose
Describe how a user interactions with a system to achieve a specific goal. Use cases capture functional requirements from a user-centric perspective, often used in Waterfall or Hybrid environments where detailed specification is needed before implementation.
When to Use
- Complex transactional systems (banking, healthcare).
- When specific alternate flows and error handling must be rigorously defined.
- Regulatory compliance requires detailed documentation.
- Bridging gap between business needs and technical functional specs.
Anatomy of a Use Case
Key Elements
- Use Case Name : Verb-Noun phrase (e.g., "Withdraw Cash").
- ID : Unique identifier (e.g., UC-ATM-01).
- Actor(s) : Who interacts? (Primary: Initiates; Secondary: External systems).
- Description : Brief summary of goal.
- Preconditions : What must be true BEFORE this starts? (e.g., "User is logged in").
- Trigger : What starts the use case? (e.g., "User clicks Withdraw").
- Main Success Scenario (Basic Flow) : The "Happy Path" steps.
- Alternative Flows (Extensions) : Variations or error paths.
- Postconditions : What is true AFTER reliable completion? (e.g., "Balance updated").
- Business Rules : Logic links.
Use Case Template
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者，精准高效
