代码生成流程图 / 时序图提示词(Mermaid 格式,可直接贴进 Markdown 和飞书文档)

要给复杂的业务代码画流程图或时序图(写技术文档、给新人讲解、做评审)时用:把代码贴给 AI,得到忠实于代码的 Mermaid 图,并附上代码位置对照,避免画出「理想中」而不是「实际上」的流程。

NNathaniel bigo··原创首发·AI 辅助撰写
通用大模型 对话模型通用
请阅读下面的代码,画出它实际的执行流程。

- 图的类型:[流程图/时序图/状态图/让你判断]
- 关注的范围:[如从收到下单请求到返回结果]
- 读者:[如新入职的后端同学、产品经理]
- 代码(可以是多个文件,注明文件名):
  [粘贴代码]

要求:
1. 先用 5 到 10 行文字概括主流程,再画图。
2. 图必须忠实于代码:
   - 每个判断分支、提前返回、异常处理都要体现;
   - 时序图里的参与者对应代码里真实的类、服务或外部系统,调用顺序和代码一致;
   - 异步调用(消息、事件、后台任务)用虚线或备注标明;
   - 代码里没有、但你认为「应该有」的步骤,不要画进图里,放到最后的「发现的问题」中。
3. 节点文字用中文简短描述,不超过 12 个字;需要说明的细节放在备注里。
4. 图太大时(超过约 25 个节点)拆成一张总图和几张子流程图。
5. 用 Mermaid 语法输出,放在 mermaid 代码块里。注意避免常见的语法错误:节点文字中包含括号、引号等特殊字符时要用双引号包起来。
6. 图后附一张对照表:图中的关键节点 | 对应的文件与函数。
7. 最后列出画图过程中发现的问题,例如:某个异常被吞掉、某个分支永远不会走到、调用顺序可能导致的数据不一致。

高亮处换成你自己的内容:[流程图/时序图/状态图/让你判断]、[如从收到下单请求到返回结果]、[如新入职的后端同学、产品经理]、[粘贴代码]

ChatGPT Plus 充值

已被复制 0 次

使用说明

怎么填变量:[图的类型] 拿不准时写「让你判断」:多个系统之间来回调用适合时序图,单个函数里分支多适合流程图,订单、审批这类有状态的对象适合状态图。[读者] 是产品经理时,AI 会把技术细节收进备注里。

常见坑:

  • AI 画图时容易「美化」流程,把代码里实际没有的校验步骤也画上去。模板要求只画代码里有的,缺失的放进「发现的问题」,这部分常常比图本身更有价值。
  • Mermaid 对特殊字符比较敏感,节点文字里出现括号、冒号、引号时容易渲染失败。渲染报错时把错误信息贴回去让它修。
  • 一张图塞几十个节点就没法看了,拆成总图加子图。

追问技巧:图出来后可以追问「标出这个流程中所有会访问数据库的步骤」或「在时序图上标注每一步的超时时间」,把图变成评审工具。

示例输出

示例,仅供参考(下单流程时序图)
mermaid
sequenceDiagram
    participant C as 客户端
    participant O as OrderService
    participant I as 库存服务
    participant P as 支付网关
    participant MQ as 消息队列
    C->>O: 提交订单
    O->>I: 扣减库存
    alt 库存不足
        I-->>O: 失败
        O-->>C: 返回「库存不足」
    else 扣减成功
        O->>P: 创建支付单
        P-->>O: 返回支付链接
        O--)MQ: 发送「订单已创建」事件
        O-->>C: 返回支付链接
    end
节点位置
扣减库存order/service.py 的 create_order()
发送事件order/events.py 的 publish_created()

发现的问题:创建支付单失败时,已扣减的库存没有回滚。

同款作品

用这条提示词做出来的作品;原作者会因此获得积分

做同款

还没有同款,来做第一个。

Nathaniel 的更多内容

同主题

同模型

0 条评论

登录 后参与评论

还没有评论,来抢沙发~