Skip to content

rse/ase / plugin/skills/ase-code-explain

ase-code-explain

Verified

Explains code with WHAT, WHY, ANALOGY, DIAGRAM, CRUXES, and GOTCHAS. Use when you want to know how code works or when the user asks "how does this work?"

FileKindSize
SKILL.mdskill md4.3 KB
help.mdmarkdown1.3 KB

##  NAME

`ase-code-explain` - Explain Source Code

##  SYNOPSIS

`ase-code-explain`
    [`--help`|`-h`]
    *source-reference*

##  DESCRIPTION

The `ase-code-explain` skill analyzes and explains the source code of
the referenced location in a *brief*, *standardized*, and *concise*
way along six dimensions: *WHAT* (functionality), *WHY* (rationale),
*ANALOGY* (everyday-life comparison in ELI5 style), *DIAGRAM* (Mermaid
diagram of control flow, data flow, or structure), *CRUXES* (what to
notice), and *GOTCHAS* (what to not stumble over).

For a project with `black` boxing, only the minimal *WHAT* dimension is
explained.

##  ARGUMENTS

-   *source-reference*:
    A file, directory, function, or other reference to the source code
    to explain.

##  SCENARIOS

-   You want to understand how a piece of code works
-   You want an explanation with WHAT, WHY, analogy, and diagram
-   You want the cruxes and gotchas of unfamiliar code pointed out
-   You want a quick orientation before touching foreign code

##  EXAMPLES

Explain a single source file:

```text
❯ /ase-code-explain src/parser.ts
```

Explain a specific function:

```text
❯ /ase-code-explain src/parser.ts#parseExpression
```

##  SEE ALSO

[`ase-code-insight`](../ase-code-insight/help.md), [`ase-code-analyze`](../ase-code-analyze/help.md), [`ase-arch-analyze`](../ase-arch-analyze/help.md).
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 321kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 321kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 321kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 321kUpdated Claude CodeCodexVerifiedInstall