skills.rest
HACK-WU
HACK-WUCOMMUNITY
Explore all skills by this author →
GitHub

module-teach

Generates structured Markdown tutorials explaining code modules and git changes with diagrams.

2|Updated Jun 8, 2026
Search Tags:#code review#documentation#onboarding#code explanation#teaching#git diff#code walkthrough
One-click install
npx skills add https://github.com/HACK-WU/skills --skill module-teach-hack-wu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: module-teach
Source: https://github.com/HACK-WU/skills/tree/main/skills/module-teach
Command: npx skills add https://github.com/HACK-WU/skills --skill module-teach-hack-wu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Reading unfamiliar code or understanding a large commit is a high-cognitive-load task. This Skill turns it into a verifiable, progressive teaching workflow that produces reusable Markdown learning materials with diagrams, so you can quickly build accurate mental models of a module or a change. ## Core Features & Use Cases - Module walkthroughs: Produces a phased archive (capability outline, code wiki, correctness audit, behavior walkthrough, use cases, data flow, final document) with Mermaid diagrams and SVG illustrations, each conclusion traceable to file and line references. - Change explanations: Explains commits, PRs, or arbitrary diff ranges with before/after comparisons, intent labeling (explicit vs inferred), and evidence-based impact analysis, defaulting to a lightweight mode that can be upgraded on demand. - Quality gates and review: Enforces a correctness re-verification phase against the actual code, dual-perspective reviews (pedagogy and newcomer), and optional quiz-based knowledge checks with cross-round progress tracking. - Use Case: After pulling a large PR you don't understand, ask for an explanation and receive a structured breakdown of what changed, why, and who is affected, with every claim backed by diff and caller evidence. ## Quick Start Ask the AI to explain a module or commit, for example: explain the src/order module so I can take it over, or walk me through what commit a1b2c3d changed and why.

Frequently Asked Questions about module-teach

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

FAQPage Schema
How do I get an AI to explain an unfamiliar code module?▼

Point the AI at the module path and ask for a walkthrough. The skill runs a phased process producing a capability outline, code wiki, behavior walkthrough, and data flow analysis as Markdown files under a .teach directory, with every conclusion linked to file and line references.

How to understand what a git commit or PR actually changed?▼

Ask for an explanation of the commit SHA or PR number. The skill uses the diff as the sole source of truth, groups changes by intent, shows before/after comparisons, and verifies impact on callers with search or code-graph evidence rather than guessing from the diff.

Can it explain large modules with many files?▼

Yes. Modules over roughly 20 files, or with deep directory nesting or unrelated sub-responsibilities, are automatically split into sub-modules. Each sub-module gets its own walkthrough, and a summary document with a dependency graph ties them together.

Does it judge whether a change should be merged?▼

No. It only describes and explains what a change does, why, and who it affects. Open questions are recorded as items to confirm with the author, and merge decisions are explicitly delegated to a separate code review skill.

Where are the generated teaching materials stored?▼

All outputs are written as Markdown files under a .teach directory inside the project being explained, organized by module or change. Diagrams use embedded Mermaid blocks and standalone SVG files, and committing the directory is left to the user.

Related Skills

Explore More Software Engineering Skills→
openwopopenwop
1

pr

Create structured pull requests for the openwop repository with compliance checks.

Official
Intermediate
lightseekorglightseekorg
11

map

Map SMG crate ownership and inter-crate dependencies into a graph.

Official
Intermediate
jeje-itjeje-it

tailwind-4-docs

Syncs and queries a local Tailwind CSS v4 documentation snapshot for migration and implementation guidance.

Community
Intermediate
adiytharpansaadiytharpansa

explain-code

Explain code with analogies, ASCII diagrams, and step-by-step walkthroughs.

Community
Basic