tracedocs
Turn any codebase into an evidence-grounded documentation package (overview,
operation, deployment, learning, architecture, API/data, troubleshooting,
maintenance) plus a machine-readable index.json for AI agents. Every
operational/deployment claim cites a source file and a confidence label
(Verified / Inferred / Unknown / Needs confirmation); it never invents
deployment steps and records gaps instead.
Full skill, references, templates, and a validated sample output:
https://github.com/wxggzz/tracedocs (MIT).
When to Use This Skill
- Onboarding to, or documenting, an unfamiliar codebase
- Producing durable, in-repo docs for operation, deployment, and maintenance
- Preparing an AI-agent-ready knowledge handoff (with
index.json)
- Turning a repo into a study guide whose claims are traceable to source
What This Skill Does
- Analyzes the codebase (stack, scripts, entry points, env-var names, deploy
signals, tests).
- Builds an evidence map (source map, assumptions, generation log) with
confidence labels.
- Writes the Markdown manuals and an
index.json manifest; never invents
deployment steps.
- Runs a quality check (paths exist, commands sourced, no secret values, gaps
documented).
How to Use
Basic Usage
Use tracedocs to generate evidence-grounded study docs for this repository. Write the output to study-docs/.
Example
User: "Document ./my-app with tracedocs"
The skill scans the repo and writes a study-docs/ package (00-10 manuals +
index.json + _evidence/), citing each operational claim's source and
labelling its confidence - and explicitly noting anything it cannot verify
(for example, "no deployment configuration found in the repo").
Source: davepoon/buildwithclaude → plugins/all-skills/skills/tracedocs/SKILL.md
1---2name: tracedocs3description: "Turn any codebase into evidence-grounded Markdown docs plus a machine-readable index.json. Every claim cites its source; never invents deployment steps."4category: engineering-core5source_repo: davepoon/buildwithclaude6source_path: "plugins/all-skills/skills/tracedocs/SKILL.md"7source_url: https://github.com/davepoon/buildwithclaude/blob/HEAD/plugins/all-skills/skills/tracedocs/SKILL.md8metadata:9 source: https://skillmd.com/skills/davepoon/tracedocs10---111213# tracedocs1415Turn any codebase into an evidence-grounded documentation package (overview,16operation, deployment, learning, architecture, API/data, troubleshooting,17maintenance) plus a machine-readable `index.json` for AI agents. Every18operational/deployment claim cites a source file and a confidence label19(Verified / Inferred / Unknown / Needs confirmation); it never invents20deployment steps and records gaps instead.2122Full skill, references, templates, and a validated sample output:23https://github.com/wxggzz/tracedocs (MIT).2425## When to Use This Skill2627- Onboarding to, or documenting, an unfamiliar codebase28- Producing durable, in-repo docs for operation, deployment, and maintenance29- Preparing an AI-agent-ready knowledge handoff (with `index.json`)30- Turning a repo into a study guide whose claims are traceable to source3132## What This Skill Does33341. Analyzes the codebase (stack, scripts, entry points, env-var names, deploy35 signals, tests).362. Builds an evidence map (source map, assumptions, generation log) with37 confidence labels.383. Writes the Markdown manuals and an `index.json` manifest; never invents39 deployment steps.404. Runs a quality check (paths exist, commands sourced, no secret values, gaps41 documented).4243## How to Use4445### Basic Usage4647```48Use tracedocs to generate evidence-grounded study docs for this repository. Write the output to study-docs/.49```5051## Example5253**User**: "Document ./my-app with tracedocs"5455The skill scans the repo and writes a `study-docs/` package (00-10 manuals +56`index.json` + `_evidence/`), citing each operational claim's source and57labelling its confidence - and explicitly noting anything it cannot verify58(for example, "no deployment configuration found in the repo").5960---6162**Source:** [`davepoon/buildwithclaude`](https://github.com/davepoon/buildwithclaude) → `plugins/all-skills/skills/tracedocs/SKILL.md`