SuperAPI AI 工具集

ln-22-current-architecture-documenter

办公与效率

查看项目

更新于 10-15 23:59

技能介绍

用途:基于检出仓库的实现证据,生成当前架构的可信快照,记录“存在什么”和“如何运行”,不评分、不规定目标架构、不修复代码、也不把意图中的图当作事实。

主要能力:按检查清单跟踪每项为 PENDING、以观察到结果 PROVEN、以证据证明条件不存在 CLEARED 或存在缺口的 UNPROVEN;映射系统广度,包括语言、框架、入口点、服务、模块、数据存储、接口与部署边界;追踪代表性关键流程,涵盖同步与异步跳转、事务、重试、超时、幂等与错误传播;撰写当前状态文档,区分已观察实现与已记录意图,并标注漂移或矛盾;最后验证引用并给出 READY、INCOMPLETE 或 BLOCKED 结论。

使用方式:先确定文档契约,解析仓库范围、读者、目标路径、深度与语言,读取仓库说明并记录快照标识与脏工作树限制;搜索既有当前状态、基线、目标设计、决策、图与部署产物;复用明确的当前状态文档,否则默认使用 docs/architecture/current-state.md。除获批的架构文档外保持只读。工具优先使用 Git 状态、原生列表与搜索、清单与直接文件读取;符号与依赖可用语言智能或解析依赖工具;运行时与部署拓扑用入口点、IaC、容器、CI、配置与运行时证据;文档变更仅对获批架构文档做最小补丁,未授权可写路径则返回 BLOCKED。

适用场景:需要为已检出仓库编写当前状态架构说明、梳理关键流与部署拓扑、或为后续决策提供证据基线时使用。

限制:不提出目标架构、不做适配性审计、不修复代码;路径、图或命名约定在可执行接线或权威契约确认前仅为线索;远程专属、仅运行时、组织或生产事实若无可信证据标记为 UNKNOWN;部署关系无法确认时标记 UNKNOWN;证据不足的声明标记 UNVERIFIED;不得编造批准门;深度按实质风险缩放,保留强制检查与安全顺序;结论需绑定到检查的具体修订与相关脏/配置状态。