SuperAPI AI 工具集

tracedocs

写作与研究

查看项目

更新于 10-15 20:33

技能介绍

用途:tracedocs 用于为不熟悉的代码库生成可追溯来源的文档包,适合新人上手、编写仓库内运维/部署/维护文档、为 AI 智能体准备知识交接,以及把仓库变成结论可回溯到源码的学习指南。

主要能力:分析代码库的技术栈、脚本、入口点、环境变量名、部署信号与测试;构建证据图(源码映射、假设、生成日志)并附置信度标签;输出 Markdown 手册与 index.json 清单;执行质量检查,包括路径是否存在、命令是否有来源、是否泄露密钥值、缺口是否被记录。文档包覆盖概览、操作、部署、学习、架构、API/数据、故障排查、维护等主题。

使用方式:以自然语言指令调用,例如“Use tracedocs to generate evidence-grounded study docs for this repository. Write the output to study-docs/.”,或“Document ./my-app with tracedocs”。技能会扫描仓库并写出 study-docs/ 包(00-10 手册 + index.json + _evidence/),为每条运维结论标注来源与置信度,并显式说明无法验证的内容,例如“仓库中未发现部署配置”。

限制:不编造部署步骤,无法验证的信息以缺口形式记录而非补全;具体支持的语言、平台、安装命令与收费方式暂未提供。完整技能、参考资料、模板与已验证示例输出见 https://github.com/wxggzz/tracedocs(MIT)。