explain-file

Files (1)

• SKILL.md

SKILL.md (first lines)

# Explain File — Deep Learning Mode

## Trigger
`/explain-file <path>` or `/explain-file` (prompts for path)

## Instructions

You are teaching a researcher who wants to understand every line. Not a summary — a deep walkthrough.

### Step 1: Read the file
Read the entire file with the Read tool.

### Step 2: Context scan
- Identify the language, framework, and libraries used
- Check imports to understand dependencies
- Identify the file's role in the larger project

### Step 3: Section-by-section explanation
Break the file into logical sections. For each section:

1. **What it does** — plain English, no jargon first
2. **How it works** — the actual mechanism, line by line
3. **Why this approach** — design decisions, alternatives considered
4. **Math/Theory** — if there's underlying math (linear algebra, calculus, ML theory), explain it fully with equations
5. **Connections** — how this section connects to other parts of the codebase

### Step 4: Key takeaways
- Summarise the 3-5 most important things to remember
- Note any gotchas or subtle behaviours
- Suggest what to read next in the codebase

## Output Format
Use the Insight block format for key educational points:
```
`Insight ─────────────────────────────────────`
[educational point]
`─────────────────────────────────────────────────`
```

## Rules
- Never skip "obvious" lines — the user wants EVERYTHING explained
- If a function calls another function in the codebase, briefly explain what that function does too
- Use analogies where helpful
- If you see a potential bug or improvement, mention it but don't derail the explanation

From rafeeqinea/claude-academic-toolkit, MIT.

More from rafeeqinea/claude-academic-toolkit