OpenParable
Skip to content
← Back to skills

Tracedocs

Documents
tracedocs

Tracedocs is an Agent Skill for documents published in the davepoon/buildwithclaude repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Turn any codebase into evidence-grounded Markdown docs plus a machine-readable index.json. Every claim cites its source; never invents deployment steps.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/davepoon/buildwithclaude/blob/HEAD/plugins/all-skills/skills/tracedocs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/tracedocs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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").