understand
Installation
SKILL.md
understand
An explainer is a page a human reads to understand work an agent did. The reader is the user in six months, or a colleague with little context: they know how to code, not this repo. The page answers three questions: what is this, why does it exist, how does it work. When the work changed what users see, the page shows it before it tells it, and it shows every visible change, asked for or not. Every claim is pinned to code, so the page stays honest after its author is gone.
Invocation:
| Command | Target | Output folder |
|---|---|---|
understand <slug> |
a done .workflow/<slug>/ run |
.workflow/<slug>/understand/ |
understand <area> |
a path, feature or question about the repo | docs/understand/<topic>/ (<topic> = kebab-case of the area) |
understand |
— | list the three most recently wrapped runs, lettered, and ask |
The page is explainer.html in the output folder; screenshots this skill takes go in its
screens/, a video in its video/. --video or --no-video after the target answers the
video question in advance. <skill> below is this skill's folder.