SuperAPI AI 工具集

uw-analyze-messaging

数据与分析

查看项目

更新于 10-30 10:34

技能介绍

该技能面向事件驱动架构的消息层分析,适用于分析消息队列、异步处理与发布/订阅模式。

用途:对代码库中的消息层进行结构化梳理,生成可供机器读取的文档,并附上指向源码的链接。

主要能力:识别事件与消息类及其 Schema,包括 JSON Schema、Avro 或 Protobuf 定义;查找发布者与生产者并记录实现代码;查找监听器与消费者,记录重试、错误处理与 DLQ(死信队列)配置;在 index.md 中汇总主题概览与事件流图。输出结构为 docs/unwind/layers/messaging/,包含 index.md、events.md、producers.md、consumers.md;当代码库较大(10 个以上主题)时,按主题拆分文件,例如 order-events.md、user-events.md 等。

使用方式:采用增量写入流程。先创建目录并写入初始 index.md;然后逐个分析事件、生产者、消费者,每完成一类就立即写入对应文件并更新 index.md;最后补齐 index.md 中的主题表与事件流图。每个事件、生产者、消费者和处理器标题都需标注 [MUST]、[SHOULD] 或 [DON'T];消息层的默认建议为:事件 Schema、核心生产者、核心消费者、webhook 处理器标 [MUST];定时任务、重试逻辑、死信处理标 [SHOULD];消息代理配置、序列化配置标 [DON'T]。若输出目录已存在,则进入刷新模式,对比当前状态并在 index.md 添加“Changes Since Last Review”章节。

适用场景:审查消息系统与事件架构、补充或更新消息层文档、梳理主题与事件流、核对消费者重试与死信配置。

限制:仅覆盖消息层;文档中的不确定项需要归入 Unknowns。其它系统层、具体框架的适配范围与执行环境要求暂未提供。