关于 tracedocs
tracedocs 是一款从代码库生成有源码依据文档包的 Skill，适用于维护者、开发者及 AI Agent 交接。它为运维声明标注来源和置信度，记录未知项，并检查生成的文档。
主要功能
- 01分析代码库结构与部署信号
- 02映射证据并标注置信度
- 03生成手册和 index.json
- 04记录缺口而不臆造步骤
- 05检查路径、命令和机密信息
适用场景
- 01为陌生代码库编写文档
- 02准备运维和部署手册
- 03制作面向 AI Agent 的知识交接材料
- 04构建可追溯源码的学习指南
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/tracedocs确认已加载。
详细介绍
tracedocs
将任意代码库转化为以证据为依据的文档包（概览、运行、部署、学习、架构、API/数据、故障排除、维护），并提供供 AI Agent 使用的机器可读 index.json。每条运行或部署相关的声明都会引用源文件并标注置信度（已验证 / 推断 / 未知 / 需要确认）；绝不编造部署步骤，而是记录缺失信息。
完整技能、参考资料、模板和经过验证的示例输出： https://github.com/wxggzz/tracedocs (MIT)。
适用场景
- 熟悉或记录不熟悉的代码库
- 编写持久的仓库内文档，涵盖运行、部署和维护
- 准备适用于 AI Agent 的知识交接材料（含
index.json） - 将代码库转化为学习指南，并确保其中的声明均可追溯到源代码
此技能的功能
- 分析代码库（技术栈、脚本、入口点、环境变量名称、部署信号、测试）。
- 构建证据映射（源文件映射、假设、生成日志），并标注置信度。
- 编写 Markdown 手册和
index.json清单；绝不编造部署步骤。 - 进行质量检查（路径存在、命令有来源、无机密值、缺失信息已记录）。
使用方法
基本用法
Use tracedocs to generate evidence-grounded study docs for this repository. Write the output to study-docs/.
示例
用户：“使用 tracedocs 为 ./my-app 编写文档”
该技能会扫描仓库并生成 study-docs/ 文档包（00-10 系列手册 + index.json + _evidence/），为每条运行相关的声明标注来源和置信度，并明确指出无法验证的信息（例如，“仓库中未找到部署配置”）。
评论
支持 Markdown