Files
cursor__plugins/pstack/docs/guide/03-understand.md
lauren 02c03a9ded pstack: add public usage tutorial (#164)
* pstack: add public usage tutorial

Co-authored-by: lauren <poteto@users.noreply.github.com>

* pstack: document verification skill workflows

Co-authored-by: lauren <poteto@users.noreply.github.com>

* pstack: mention verification setup offer

Co-authored-by: lauren <poteto@users.noreply.github.com>

* pstack: clarify optional verification setup

Co-authored-by: lauren <poteto@users.noreply.github.com>

* pstack: rewrite tutorial prompts to match real usage

The example prompts read like specs. Real prompts are short, informal,
and goal-first, so every example now uses that register. The prose
reshapes around them: friendly second-person tutorial voice, goals
before mechanics, pitfalls where readers actually trip, and the
playbook reference table replaced with prompts in context. Every
skill claim re-checked against the skill files at this commit.

* pstack: make the README guide link an invitation

Point new readers at what the guide walks them through instead of
listing its topics.

* pstack: drop the version bump

This PR only adds documentation, so the plugin manifest stays at
main's 0.11.7.

* pstack: add illustrations to the guide

One hero image per major guide page (routing, understanding, design,
verification, overnight runs, recipes), 1200px JPEGs under
docs/guide/images/.

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2026-07-22 16:18:26 -07:00

62 lines
3.7 KiB
Markdown

# Understand the code before changing it
Editing code you don't understand is how subtle regressions ship. pstack gives you four ways in. `/how` explains what the code does now. `/why` digs up the reasons it's shaped that way. `/teach` blends both into one explanation. `/recall` rebuilds your own recent context on a topic.
![A detective studies a machine blueprint with a magnifying glass while robots fetch case files; the evidence board behind her links clues under /how and /why.](./images/understanding.jpg)
## Trace behavior with `/how`
```text
/how do we dedupe notifications? is there an n+1 when we look up subscribers?
```
Ask the question you actually have. [`/how`](../../skills/how/SKILL.md) reads the code and answers at the level of a senior engineer onboarding you onto the subsystem, with the runtime flow, the key types, and the non-obvious parts. For a big subsystem it fans out two to four read-only explorers first. For a narrow question it just reads and explains.
`/how` can also push back on the design. Ask for Critique mode when you suspect the structure itself:
```text
/how explain the sync service, then critique its ownership boundaries
```
The explanation comes first, so the critique stays grounded in how the thing really works.
## Dig up history with `/why`
```text
/why was the retry limit set to five? does the reason still hold?
```
[`/why`](../../skills/why/SKILL.md) works like a detective on a cold case. It starts from source control, then queries whatever evidence categories your MCPs expose, such as the issue tracker, long-form docs, team chat, observability, error tracking, and analytics, all in parallel. The report cites everything, separates direct evidence from inference, and says "appears to" when the record is thin. A null result gets reported too, because "nobody wrote down why" is itself an answer.
The two compose naturally. `do why first then how` is a perfectly good prompt when you suspect the history explains the mess.
## Actually understand it with `/teach`
```text
/teach me how this PR changes retries. convince me it fixes the cause and not the symptom.
```
[`/teach`](../../skills/teach/SKILL.md) is for when a summary isn't enough. It runs `/how` and `/why`, for a small change maybe just one of them, and weaves the findings into a plain explanation that builds up diagram by diagram. The "convince me" framing is worth stealing. It turns the explanation into an argument you can poke at instead of a tour.
## Rebuild your own context with `/recall`
```text
/recall catch me up on the export work from last week
```
[`/recall`](../../skills/recall/SKILL.md) mines your own recent chats plus the shared record (issues, prior fixes, errors still firing) and hands back a brief on where things stand and what's next. Use it when you're returning to a topic cold. If you want to resume one specific chat, that's the Session pickup playbook below, not `/recall`.
## Take over prior work with Session pickup
When another agent (or you, last week) left a branch mid-flight:
```text
/poteto-mode take over this branch. read the decision log, figure out what's done, and continue from there. don't redo finished work.
```
The [Session pickup playbook](../../skills/poteto-mode/playbooks/session-pickup.md) treats the prior trail as authoritative. It reconstructs the branch state and decisions, names the resume point, and verifies inherited claims against the original goal instead of re-deriving everything from scratch.
**Pitfall:** don't skip this page's skills because "the agent will read the code anyway." An agent that starts editing without a traced model tends to fix the symptom at the first plausible spot. `/how` first is cheaper than the second bug.
Next: [Design the change](./04-design.md).