walkthrough

Generates an end-to-end narrative walkthrough document explaining how a repository's system works.

Updated Jul 29, 2026
One-click install
npx skills add https://github.com/chris-prener/dev-kit --skill walkthrough-chris-prener
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: walkthrough
Source: https://github.com/chris-prener/dev-kit/tree/main/dev-kit/skills/walkthrough
Command: npx skills add https://github.com/chris-prener/dev-kit --skill walkthrough-chris-prener

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New team members and maintainers struggle to understand how a codebase works end to end — from raw inputs through every transformation to final outputs — without a single coherent document tracing execution order, data lineage, and helper functions. ## Core Features & Use Cases - Deep codebase analysis: Maps repository structure, traces execution order and data lineage, catalogs inputs, outputs, and helper functions before writing. - Structured document generation: Produces docs/walkthrough.md with overview, architecture, data model, per-step sections, helper reference, output data dictionary, and how-to guides. - Verification and issue filing: Fact-checks every claim against the code and auto-files backlog issues for stale sections, contradictions, or unverified claims. - Use Case: After inheriting an unfamiliar data pipeline repository, ask for a walkthrough to receive a verified, narrative technical guide covering every component from entry point to final outputs. ## Quick Start Ask Claude to create a walkthrough of this repository explaining how the system works from raw inputs to final outputs.

Frequently Asked Questions about walkthrough

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document how a codebase works end to end?▼

Use the walkthrough skill to analyze the repository's execution order, data lineage, and helper functions, then generate a narrative document at docs/walkthrough.md. It writes for a reader who knows the language but has never seen the repository.

How to create a technical walkthrough of a data pipeline?▼

Invoke the skill with trigger phrases like "create walkthrough" or "document the data flow". It traces transformations, row counts, validation checkpoints, and primary keys, then writes step sections, a data model, and an output data dictionary.

Does the walkthrough skill modify my code?▼

No, the skill explicitly forbids changing code. It only reads the repository to verify every claim against actual source files and writes a single documentation file to docs/walkthrough.md.

What is the difference between walkthrough and README documentation?▼

The walkthrough provides an end-to-end internal explanation of how the system works, while a README covers project overview and usage. The skill defers README-only work to the readme skill and docstrings to the documentation skill.

What happens when the walkthrough finds outdated documentation?▼

Findings of medium severity or higher are auto-filed as backlog issues using the tech_debt template with documentation labels and deduplication IDs. Low-severity findings stay within the walkthrough update only.