SuperAPI AI 工具集

update-docs

智能体与模型

查看项目

更新于 10-16 08:05

技能介绍

用途:对代码库进行文档审计与生成,定位文档缺口,创建缺失内容、更新过时内容、删除误导内容。

主要能力:以文档架构师角色运行,由 Codex 负责批量起草,多个专用代理分别审计不同方面。工作流会并行启动 4 个 Task 代理:高层文档(README、ARCHITECTURE.md、CLAUDE.md、ADR 基础设施)、模块级文档(各模块 README、深浅检测、导航指南)、决策记录(扫描 git 历史与代码库,找出未记录的非显而易见决策)、状态与流程图(为有状态组件和复杂流程生成 Mermaid 图)。详细代理指令见 references/agent-prompts.md。

使用方式:调用 /update-docs。输出包括已创建文档、已更新文档、需要用户输入的事项、已足够好的项目;若有变更则提交。

适用场景:需要系统性补齐或刷新项目文档、希望为有状态组件补充状态图、或想从 git 历史中挖掘并记录架构决策时。

限制:资料未提供具体安装命令、依赖环境、支持平台、收费方式或效果保证;实际代理行为与输出质量取决于代码库和运行环境。