mcpField
T
tracedocs

tracedocs

github.com/davepoonDevelopment3.7k43 installsUpdated today
Repository

About tracedocs

tracedocs is a skill for producing source-grounded documentation packages from codebases, for maintainers, developers, and AI-agent handoffs. It cites files for operational claims, labels confidence, records unknowns, and checks the generated docs.

Key features

  1. 01Analyzes codebase structure and signals
  2. 02Maps evidence and confidence levels
  3. 03Generates manuals and index.json
  4. 04Records gaps without inventing steps
  5. 05Checks paths, commands, and secrets

Use cases

  1. 01Documenting an unfamiliar codebase
  2. 02Preparing operation and deployment manuals
  3. 03Creating an AI-agent knowledge handoff
  4. 04Building a source-traceable study guide

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/davepoon/buildwithclaude --skill tracedocs

After installing, type/tracedocsin Claude Code to confirm it loaded.

Details

From the project README

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

  1. Analyzes the codebase (stack, scripts, entry points, env-var names, deploy signals, tests).
  2. Builds an evidence map (source map, assumptions, generation log) with confidence labels.
  3. Writes the Markdown manuals and an index.json manifest; never invents deployment steps.
  4. 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").

Comments

Markdown supported