docs: add optional use case diagram guidance

2026-10-28 15:53:35 +08:00
parent fb5c97cf66
commit 0acb959300
3 changed files with 6 additions and 1 deletions
@@ -66,6 +66,8 @@ description: Use when a user describes a new ERP business process or requests a

 跨角色流程优先用一张紧凑的主流程图，简单流程可用文字箭头表达；图能帮助理解复杂表单时才增加页面示意。不同时堆叠功能相同的流程图、状态图和例子。

+当角色与功能职责需要集中说明时，增加一张用例图，只展示主要角色和核心功能。已有流程图或角色表能够清楚表达时，可省略，避免重复。
+
 图示标明拟建页面或示意，虚构例子不得当作实际记录。Word 嵌入可见图形，Markdown 引用有效图片；图文中的角色、字段和结果保持一致。

 默认使用“验收场景｜预期结果”表，按核心业务合并场景。操作条件确有歧义时再增加“前置条件与操作”列。验收是待执行要求，不写成已通过；上线准备和未决事项各保留必要的简短说明。
@@ -16,6 +16,8 @@

 写出“发起 → 审批 → 办理 → 结果”的实际流程及负责角色，按业务调整。跨角色衔接可配一张紧凑主流程图，不重复堆叠同义图示。

+需要集中说明角色与功能职责时，可按需增加一张用例图，只展示主要角色和核心功能；已有流程图或角色表足够清楚时省略，不另设固定章节。
+
 ## 3 功能需求

 ### 3.1 菜单与入口
@@ -15,7 +15,7 @@
 | 验收与上线 | 核心场景、预期结果、准备工作 | 两列表格及简短上线说明 |
 | 评审确认事项 | 影响定稿的真实未决问题及责任人 | 短表或列表，已确认事项移出 |

-现状对比、功能建设清单、统计口径、详细状态表、页面示意均按需要加入，不是必填章节。不为填表编造现状。篇幅随业务复杂度确定，不把某次四页文档或六项验收当作固定指标。
+现状对比、功能建设清单、统计口径、详细状态表、用例图、页面示意均按需要加入，不是必填章节。不为填表编造现状。篇幅随业务复杂度确定，不把某次四页文档或六项验收当作固定指标。

 ## 内容粒度

@@ -49,6 +49,7 @@
 ## 图示与示例

 - 图用于解释角色衔接或不易理解的页面；一张主流程图已能说明时，不重复增加同义图或逐步骤示例表。
+- 用例图用于集中展示主要角色与核心功能，流程图用于说明办理顺序。需要概览角色职责时增加用例图；已有流程图或角色表能清楚表达时省略，不设为必备图示。
 - 页面示意标注“拟建页面／非现有界面”；实站截图注明环境和观察日期，不能把图上的字段、数量或状态当作行为验证。
 - 虚构例子明确标注，不通过样例设定未知限额；金额和时间计算用确定性方法核对。
 - 表格适合菜单、字段、角色和验收的并列信息；长说明用正文。删节靠减少重复和合并内容，不靠缩小字号或挤压行距。