fed notes

Appearance

Mermaid ​

https://mermaid.ai/open-source/intro/

flowchart：业务流程与异常分支

sequenceDiagram：服务调用关系与时序（谁先谁后、同步异步、失败返回）

stateDiagram-v2：状态流转与事件条件（复杂规则防歧义）

erDiagram：数据库实体关系（表、主外键、基数）

沟通模版 ​

【背景】
我要做一个邀请码注册系统

【当前设计】
- user 模块：创建用户
- role 模块：角色
- iam 模块：绑定关系

【流程】
（贴 Mermaid）

【我的疑问】
1. role 绑定应该在哪个 domain？
2. 是否需要事务？
3. init 模块是否合理？
【目标】
我要实现什么？

【现状】
我现在怎么设计的？

【结构】
（贴 diagram / code / schema）

【冲突点】
我卡在哪里？

【具体问题】
1.
2.
3.

沟通模板 ​

目标:
输入:
输出:
规则:
异常:
边界:
验收:

示例：

目标：要完成什么（例如“注册成功后自动绑定 role”）
输入：入口参数（phone/email、otp、invite_code）
输出：返回给前端什么
规则：业务约束（邀请码一次性、OTP 5分钟）
异常：失败分支（过期、已用完、频控）
边界：事务范围/一致性要求
验收：你认定“完成”的标准（接口、测试点、状态）

分级 ​

L1（模糊）：业务主干（5-8个节点）
用来对齐“做什么”

L2（中等）：关键分支和异常
用来评估“会不会漏场景”

L3（详细）：接口、字段、状态机、事务边界
用来落实现

建议 ​

需求用 flowchart，接口评审用 sequenceDiagram，数据评审用 erDiagram，状态规则用 stateDiagram

  • “流程” -> flowchart
  • “调用顺序/接口边界” -> sequenceDiagram
  • “状态变化规则” -> stateDiagram-v2
  • “表设计” -> erDiagram
  • “代码对象关系” -> classDiagram