SuperAPI AI 工具集

data-flow-doc

数据与分析

查看项目

更新于 10-15 22:19

技能介绍

用途:把某个功能或系统中数据的流动过程写成结构化、可读的文档,覆盖从用户触发动作,到 API、服务、状态管理与 UI 更新的完整链路。输出同时包含便于理解的文字说明和便于绘图的 Mermaid 结构。

主要能力:文档固定包含三部分——流程摘要(1–3 句)、分步追踪(每步标注层级、动作、数据形态与备注)、图表(请求响应类用 sequenceDiagram,分支决策类用 flowchart TD,状态机用 stateDiagram-v2)。可选增加错误与边界情况表格。层级词汇统一为 User、UI Component、Hook/Store、Router、Service/Util、API Client、API Route/Controller、Middleware、Service Layer、Repository/ORM、Database、External、Cache,只写实际存在的层级。

使用方式:先确定流程入口(事件处理器、useEffect、路由处理器、队列消费者、定时任务等),再逐层向前追踪函数调用、传入传出数据、同步或异步、是否分支;随后识别状态变更与副作用(setState、dispatch、localStorage、Cookie、URL 参数、缓存失效、后台任务、事件发送);最后追踪到 UI 结果并撰写文档、绘制图表。支持代码粘贴、口头描述、部分信息、已有文档、架构图等多种输入;信息缺失时用 [?] 或 [待确认] 标注,不臆造实现细节。

适用场景:梳理登录、下单等请求响应流程,排查异步与状态相关缺陷,做设计交接或代码库文档统一。

限制:图表建议不超过 20 个节点,过长需拆分子流程;不解释通用库的通用行为,只描述具体代码库中的具体流程;交付前需自查层级完整、数据形态明确、异步步骤标注、至少一条错误路径、Mermaid 语法可编译。具体安装与调用方式暂未提供。