SuperAPI AI 工具集

code-documentation

写作与研究

查看项目

更新于 10-15 17:30

技能介绍

用途:在用户要求为代码生成、创建或改进文档时使用,适用于 README、API 参考、开发者指南、架构文档(含图示)、变更日志或迁移指南等需求。

主要能力:生成带徽章、安装、用法与 API 参考的 README;从源码分析生成 API 参考;产出含图示的架构与设计文档;编写开发者入门与贡献指南;依据提交历史或发布说明生成变更日志;按语言惯例生成行内注释,支持 JSDoc、docstring、GoDoc、Javadoc、Rustdoc;并适配项目语言与生态风格。

工作流程:先做代码库分析(识别语言、框架、构建系统、包管理器、目录结构、入口点与已有文档,并用沙箱工具探查代码结构与公开 API),再按项目规模决定文档范围,依次生成 README、API 参考、架构文档与行内注释,最后做完整性、准确性与交叉引用校验。

风格与输出:遵循先讲原因、渐进披露、用示例说明、主动语态、现在时、第二人称等原则;使用 ATX 标题、带语言标注的代码块、表格与提示块。生成文件保存到 /mnt/user-data/outputs/,多文件时保持项目目录结构,可用 present_files 展示,并支持迭代调整。

限制:必须先分析实际代码,不得猜测 API 签名或行为;已有文档在未明确要求重写时应保留结构;大型代码库优先文档化公开 API 与关键抽象;文档语言默认与项目已有文档一致,否则默认英文;变更日志采用 Keep a Changelog 格式。其他细节暂未提供。