SuperAPI AI 工具集

doc-and-modernize

写作与研究

查看项目

更新于 10-15 21:52

技能介绍

用途:针对用户本地已检出的代码库,提供文档与现代化两套互补工作流。文档模式产出单一、可验证、带引用的架构文档,适合新人上手、系统设计梳理,或作为现代化改造的证据基础;现代化模式把架构转化为分阶段、带安全梯级的升级、迁移或重写计划。

模式选择:想理解、记录、梳理或上手代码库时用文档模式;想现代化、迁移、升级或重写时用现代化模式。现代化模式自足:若尚无架构文档,会先在同一轮运行文档模式工作流,再直接进入计划。

文档模式:以本地检出为默认来源,更快、免费、无速率限制,且描述的是眼前的确切代码;远程独有事实(星标数、完整 CI 历史、兄弟仓库)不可见,应标为超出范围或 [UNVERIFIED]。先确立身份:运行 git remote -v、git branch --show-current、git log -1,记录远程、分支、提交,并抹除 URL 中可能内嵌的凭据。读取真实清单(go.mod、package.json、Cargo.toml、pyproject.toml、pom.xml 等)、Makefile/任务运行器、CI 配置及仓库内 AGENTS.md、CONTRIBUTING、README、docs/。先做全仓地图,再深入 2-3 个最难子系统。输出单个 Markdown,含三部分:全仓技术深潜(技术栈检测表、入口点、命令与验证清单、目录布局、部署与运行时表面、EOL/死依赖扫描、数据层、API、插件、后台任务、CI/CD、测试);上下文与生态(检出身份表、贡献者文档、开发陷阱、与生态关系);架构蓝图(技术栈摘要、Mermaid C4 图、分层与依赖规则、横切关注点表、推断的 ADR、治理机制、如何加功能)。约定:每条非显然论断引用本地路径与行号;用 [INFERRED]、[UNVERIFIED] 诚实标注不确定;解决矛盾而非复述;记录兼容性与部署节奏规则;用精确计数。

现代化模式:假定默认已死,不假设能复活旧工具链并先建全绿 CI。先做限时可行性探针,再按系统存活程度选择迁移策略与安全策略。核心概念:可测试性里程碑(组件何时能重新构建、运行并通过测试)、安全梯级、CI 里程碑(哪个阶段先建 CI,且将 CI 设为必需检查是人工步骤)。前置条件:需先有架构文档,否则先运行文档模式;并确认存在命令与验证清单,退出标准才可运行。工作流:阶段一从现有文档评估现状(技术栈、功能域、痛点、部署),不重读每个源文件;阶段二做限时可行性探针、策略分叉与安全梯级,按组件定位可测试性里程碑,并标注每个阶段处于可测试前还是可测试后。资料未提供具体命令、价格、平台或效果信息。