SuperAPI AI 工具集

as-built-architecture

办公与效率

查看项目

更新于 10-15 20:08

技能介绍

用途:对既有代码库建立基于事实的架构快照,目标是让用户能理解当前系统实际构建成什么样,而非改进、重构或重新设计。以仓库为事实来源,代码与运行时行为优先于文档和命名约定;严格区分观察到、推断与未知三类信息,不把预期架构当作事实。

主要能力:建立仓库地图(文件清单、清单文件、构建/CI/容器/环境配置、语言与包管理器、可能的 monorepo 边界);识别入口与运行时面(服务器、路由、CLI、worker、cron、队列消费者、构建/测试/部署命令、端口与环境变量);梳理依赖与内部边界;运行安全的既有命令验证运行时事实;将现有测试作为架构证据解读;理解数据、状态与外部系统;追踪两到四个代表性流程;汇总为 as-built 模型并指出隐含耦合、所有权不清、文档与代码不一致、测试缺失等影响。

使用方式:先用 git status --short 查看工作区状态,用 rg --files 等快速枚举文件,读取顶层文档与配置;再定位入口点,用现有项目命令(脚本列表、类型检查、lint、构建、定向测试、路由列举)做轻量验证;如需启动本地服务需在允许范围内,并干净关闭。运行前后都应检查 git status --short,记录命令产生的缓存、构建产物等。

产出与限制:最终交付为自包含 HTML 报告,保存在 architecture_as_is/YYYYMMDD_HHMMSS/architecture_as_is.html,并附 manifest.md,证据、图表、导出与截图分目录存放;报告不依赖外部资源或浏览器端 Mermaid 运行时,如需图表应将 .mmd 预渲染为 SVG 后内联。默认采用只读、非破坏性探索;迁移、数据写入、部署、泄露密钥、破坏性清理与生产网络调用需显式授权。不打印密钥,不新增测试文件或探针,不更新快照或测试配置。资料未提供具体安装命令、收费信息与支持的框架清单。