SuperAPI AI 工具集

ln-72-current-architecture-documenter

办公与效率

查看项目

更新于 10-16 06:23

技能介绍

用途:为已检出仓库生成可信的“当前架构”快照,记录已实现的结构与行为,供入职上手或迁移基线使用。明确不做目标架构设计、代码修复或审计评分。

主要能力:识别快照身份与工作区状态;梳理语言、框架、构建运行命令、入口、服务、任务、部署单元;映射模块职责与依赖方向、数据存储与外部接口、运行时与部署拓扑;追踪关键流程(同步与异步跳转、事务、重试、超时、幂等、错误传播);生成含快照身份、系统上下文、组件清单、依赖与数据流、关键流程、部署与证据索引的文档,并标注 OBSERVED、DOCUMENTED、INFERRED、UNKNOWN,区分实际实现与既定意图及审计发现。

使用方式:按五项有序清单执行——确立文档契约、映射系统广度、追踪关键行为、撰写当前状态工件、验证与报告。默认复用现有当前状态文档,否则使用 docs/architecture/current-state.md;文档需锚定 remote、branch、HEAD、工作区状态与观察日期,关键结论需附文件路径、符号、命令或配置键引用。除非获得授权,运行保持只读。

适用场景:需要从仓库证据记录既有架构,用于新人了解系统或作为迁移基线,并希望清楚区分已观察事实与未验证内容。

限制:不产出目标架构、不做审计判定、不修复代码;无证据的远程、运行时、组织或生产事实标为 UNKNOWN;无法确立仓库身份、范围或可写目标时返回 BLOCKED;材料拓扑未知时结论为 INCONCLUSIVE;仅在快照有证据支撑且有用时使用 DOCUMENTED。