explain-project
Explain what a project does, the problem it solves, and its end-to-end flow.
SKILL.mdskills/explain-project/SKILL.md
GitHubWhen to use
The user uploaded a repo (often a .zip) or asks what a whole codebase does and
how it flows.
How
- Map it —
list_dir(plusgrep/findif available) for the structure; read theREADME. - Find entry points —
main/app/cli/server/index/__main__— and read them. - Explain in order: the problem it solves → the end-to-end flow (input → processing → output, naming the files) → key components → notable tech and risks.
- For a large repo,
delegatethe exploration, then synthesise the findings.
Avoid
- Inventing features; cite real files and paths.
- A file-by-file dump instead of the actual flow.
Done well
A newcomer understands, in a few minutes, why the project exists and how a request flows through it — grounded in real files.