qakit
Turn a feature an AI agent just implemented into a manual QA plan a human can actually run, with concrete steps, verification checkpoints inline, and pass/fail/skip boxes, grounded in what the code actually changed rather than a generic checklist. The plan is written to docs/qa/ so a person can walk it top to bottom and sign off on the feature by hand.
This is manual QA, meaning steps that genuinely need a human to perform and judge (click through a flow, read a screen, feel out the UX), not checks a machine can do on its own. The value is a disciplined, diff-grounded plan: what to test, in what order, with what setup, and how to know it passed, focused on the things that can't be verified without a human eye.
Anything an AI agent or script can confirm on its own, such as running a terminal command and reading its output, hitting an endpoint, or asserting a return value, does not belong in the human's checklist. The agent runs those itself and reports the results in an Automated verification section at the end of the plan, so the human sees them confirmed without re-running them by hand.
The plan is organized around setup, not around dimensions. Setup is what a manual QA pass actually costs: reseeding data, logging in, getting the app into a particular state. A plan that makes the tester rebuild the same state five times because five cases each restate it is a worse plan than one with fewer, fatter cases.
When this fires
The user finishes building something and wants to verify it by hand: "write a QA plan", "manual test plan", "how do I test this feature", "give me a testing checklist", "/qakit", or a bare "QA this" after a coding session. qakit produces a plan a human runs, and it never writes or runs test code. If the user wants automated tests (unit, integration, E2E), that's a separate concern for a test-suite skill; say so and don't produce a manual plan for it.
Procedure
1. Scope the feature
Ground the plan in what was actually built, because a generic plan is worthless. Gather, in order of preference:
- The session context, meaning what the user asked for and what you implemented this session. When you built the feature yourself, this is your best source and it costs nothing: you know its entry points and its failure modes better than the diff shows them.
- The change, when a repo is present:
git diff --stat HEAD and git log --oneline -10 to see which files and commits are in scope. A QA plan is written at the level of behavior (endpoints, screens, flags, commands, states) rather than lines, so read full diffs only for the files that carry behavior you can't already name: a route or handler, a form, a CLI entry point, a migration, a config default. Skip lockfiles, build output, and vendored directories entirely, and don't read a full diff for a file whose behavior the session already told you about.
- The user, only if intent is still unclear. Ask what the feature is supposed to do and how they normally exercise it (URL, command, screen, credentials), in one focused question, not an interview.
Write down, for yourself: the feature's intended behavior, its entry points, and its dependencies (services, data, auth, config). Everything downstream hangs off this.
2. Derive the test dimensions
Walk every dimension below and generate candidate cases for each one that applies to the feature. Skip a dimension only when it's genuinely irrelevant, and say so under Not covered in the plan so the tester knows it was considered, not forgotten:
- Happy path. The feature used exactly as intended, the primary flow end to end.
- Edge & boundary. Empty input, max/min values, off-by-one boundaries, unusual-but-valid states, duplicates, unicode/large payloads.
- Negative / error handling. Bad input, missing/expired auth, unavailable dependencies, network failures; assert it fails gracefully with a clear message and no corruption.
- Regression. Nearby behavior the change could have broken (shared components, the prior flow, adjacent features).
- Security & permissions. Role/ownership checks, access to another user's data, injection-style input, secrets not leaked in logs or responses.
- Data & state. Persistence after reload/restart, idempotency, correct create/update/delete, no orphaned or stale state.
- Concurrency & timing. Simultaneous actions, double-submit, race conditions, retries, slow responses.
- Compatibility. Where there's a UI: target browsers/OS/devices, responsive/mobile layout, dark mode.
- Accessibility. Keyboard navigation, focus order, screen-reader labels, and contrast, where there's a UI.
- Performance. Responsiveness under realistic or large data volumes; no obvious slowdown or leak.
- Usability / UX. The feel a human must judge: clear copy, sensible defaults, discoverable actions, helpful empty/loading states.
Prioritize: tag each case with one of three tiers, each carrying an emoji so the tester reads urgency at a glance:
- 🔴 Critical. Must pass to ship; a failure blocks release.
- 🟡 Normal. Should pass; a failure is a real bug but not a blocker.
- 🟢 Low. Nice-to-have, polish, or edge cases with minor impact.
Don't pad, because one clear check per behavior beats ten redundant ones. Scale the count to the feature's surface area and risk. What you have at the end of this step is a flat pile of candidate cases; the next step decides which of them are actually separate cases.
Split human-only from agent-verifiable. As you generate cases, sort each one: does confirming it require a human (visual judgment, real interaction, UX feel), or can an agent/script confirm it by running a command and reading output? Only the human-only cases reach the plan's test cases. Run the agent-verifiable checks yourself and record their outcomes in the Automated verification section, and never list a command-and-check-output step as a manual case for the human to run by hand.
3. Group the cases into scenarios
A scenario is one setup, every case that can run on top of it, and one reset at the end. Sort the candidate cases by the starting state each one needs, then:
- One scenario per distinct starting state. Two cases that need the same state belong in the same scenario, always. The tester sets up once, runs the whole scenario, resets once.
- Merge cases that share a setup and a flow. If confirming three behaviors just means walking one flow and looking at three things along the way, that's one case with three checkpoints, not three cases that each restate the same six steps. Failure isolation comes from the checkpoint, not from the case: an unticked box points at exactly one behavior just as precisely as a failed case did, and costs the tester nothing to reach. This is a merge, not a relocation, so the merged case ends up with three checkpoints, not with every assertion the three cases spelled out between them, stacked into a column of boxes. The checkpoint rules in Write the plan file are what stop the squeeze from simply reappearing one level down.
- Split only when the flows genuinely diverge, meaning a different entry point, or a case that leaves state the following case can't tolerate.
- Order within a scenario: read-only first, state-mutating next, destructive last. A case that deletes the record every other case needs goes at the end, or earns its own scenario.
- Fewest scenarios that still cover the dimensions. A new scenario has to justify itself with a genuinely different starting state; "it feels like a different topic" doesn't.
Name a scenario for the state it starts from ("Fresh tenant, no data", "Existing user with 200 orders", "Feature flag off") rather than for its topic ("Validation", "Error handling"). The name is what tells the tester whether they're already in the right state.
Number cases within their scenario: TC-<scenario>.<case>, so TC-2.3 is the third case of Scenario 2.
Everything true for the whole plan is not scenario setup. Branch, build, base URL, credentials, auth token, feature flags, and launch command go once in Environment at the top. Each scenario's Setup carries only what's specific to that scenario. This is the split that keeps setup connected to the cases that need it.
4. Write the plan file
Write to docs/qa/qa-<feature-slug>-YYYY-MM-DD.md, using a short lowercase kebab-case feature slug and the plan's ISO creation date (for example, qa-login-throttle-2026-07-23.md). Keep that date stable on later edits; record an updated date inside the document when useful. Create docs/qa/ if it doesn't exist. Update an existing QA plan for the same artifact in place. For a genuine same-day collision between distinct plans, make the slug more specific; only as a last resort insert a sequence immediately before the date (qa-login-throttle-02-2026-07-23.md).
Structure the file like this (the outer fence below is shown with four backticks only so the inner ```sh blocks display; the real file uses normal triple-backtick fences):
# QA Plan: <Feature name>
_Generated <date> · against `<commit sha>` · covers <brief scope>_
## Summary
- What the feature does, in one short sentence.
- What "working" means, in one short sentence.
## Environment
True for the whole plan. Do this once, before Scenario 1.
- Branch / build under test
- Base URL, credentials, and how to obtain any auth token the calls need
- Feature flags / config
Launch with:
```sh
<launch command>
```
- [ ] Environment ready
## Test cases at a glance
Priority legend: 🔴 Critical · 🟡 Normal · 🟢 Low
| # | Scenario | Test case | Priority |
|------|----------|-----------|----------|
| TC-1.1 | 1: <starting state> | <short title> | 🔴 Critical |
| TC-1.2 | 1: <starting state> | <short title> | 🟡 Normal |
| TC-2.1 | 2: <starting state> | <short title> | 🟢 Low |
## Scenario 1: <starting state>
**Setup.** Run once, for every case in this scenario.
1. <setup action>
```sh
<setup command>
```
- [ ] Setup complete
### TC-1.1: <short title> · 🔴 Critical
**Goal.** <one line: what this case proves>
**Steps**
1. <concrete action a human takes>
- [ ] <one judgment the tester stops to make right here>
- <what to look at, when the judgment needs a guide; a plain bullet, not a checkbox>
- <another thing taken in at the same glance>
- [ ] <a second judgment, only when it's a genuinely separate look>
2. <next action; a command goes in its own block>
```sh
<command to run>
```
- [ ] <what the output or screen must show>
**Result**
- [ ] Pass
- [ ] Fail
- [ ] Skipped
**Notes.** _what actually happened on a fail; why it was skipped_
### TC-1.2: <short title> · 🟡 Normal
...
**Reset.** Run after every case above, before moving to Scenario 2.
```sh
<reset command>
```
## Scenario 2: <starting state>
...
## Automated verification (by AI agent)
_Checks the agent ran itself. No action needed from the tester; listed here for context and sign-off._
Commands run (one per block; chain with `&&` when they must run together):
```sh
<command 1>
```
```sh
<command 2>
```
- ✅ <command 1> → <what the output confirmed>
- ✅ <endpoint / assertion checked> → <result>
- ❌ <anything that failed, with the actual output> _(if any)_
## Not covered / needs human judgment
- <anything that can't be scripted: visual polish, UX feel, external integrations, timing>
- <dimension deliberately skipped, and why>
## Overall result
_Tick one when you finish the run._
- [ ] Pass: every case passed
- [ ] Fail: at least one case failed
- [ ] Partial: cases were skipped or not reached
Rules for good cases:
Never ask the tester to transcribe something you already know. The header stamp carries the date and the exact commit the plan was written against, so fill both in yourself from git log and don't leave a blank table for a human to copy a sha into. The only thing the plan asks of the tester is the one judgment a machine can't make: the overall verdict. If they end up running against a different build than the stamp, that belongs in a case's Notes, not in a field every plan carries empty forever.
Overall result goes last, at the foot of the file. The tester ticks it when the run ends, and the run ends at the bottom of the plan. A verdict box near the top asks them to scroll back through every case they just finished, so it stays unticked.
Fixed case body, always these four parts in this order: Goal, Steps, Result, Notes. No case drops one, no case invents a fifth. A tester should be able to jump to any case in any plan and find the same shape.
Goal is one line and says what the case proves, not what it does: "an expired token can't reach another tenant's orders", not "test the orders endpoint".
Verification lives under the step that produces it. Never a separate expected-results list at the bottom of the case: a step is followed immediately by its own - [ ] checkpoints, so the tester ticks as they go instead of holding five expectations in their head and reconciling them at the end. A step with nothing to observe simply has no checkpoints.
One checkpoint per judgment, not per assertion. A checkpoint is one thing the tester stops to decide, not one fact the feature asserts. The test to apply: would they plausibly tick one box and leave the next one unticked? If they'd settle both in the same glance, it is one checkpoint. Granularity past the tester's attention doesn't buy precision, it fabricates it: nobody makes seven independent judgments while scrolling a page once, so seven boxes come back rubber-stamped and are then read as seven confirmations they never were.
Split different judgments; join one judgment applied across a set. "The footer's headings, links, separator rule and copyright are all legible" is a single look at a single region, so one box. "The icon changed to the moon" and "storage now holds dark" are two places to look, so two boxes. The word "and" is not the test; whether the tester's eye has to move is.
Detail belongs under a checkpoint, as a plain unticked sub-list. What to look at is worth spelling out, because it's the difference between "check the page" and knowing the pricing table's featured plan is the thing most likely to vanish. It just isn't worth a tick each:
1. Set the state to `light`. Scroll the whole page top to bottom at ≥1280px.
- [ ] Every block reads correctly, with nothing illegible and nothing invisible on its own background
- navbar: sticky background opaque; logo, links and control legible
- hero: heading, sub-copy, both buttons; primary label against the primary fill
- pricing-table: the toggle in both positions; the featured plan distinguishable; check marks
- footer: headings, links, separator rule, copyright
Failure isolation survives the collapse, because Notes already exists and a failing checkpoint needs a note regardless. That asymmetry is the goal: a plan that is cheap to run when it passes and only gets expensive where it fails.
A repeated pass gets one checkpoint plus whatever is new. When a second variant re-runs a sweep the tester already performed (the other palette, the second browser, the next breakpoint, the swapped preset) never enumerate the same items again. Never write "as above, in <variant>". A line that carries no observation of its own is a loop counter the human ticks by hand:
2. Set the state to `dark`. Scroll the page again.
- [ ] The same sweep is clean in dark
- [ ] Nothing is pure-black-on-dark where a muted token was intended
Every checkbox owns its own line. A - [ ] renders as a clickable checkbox only when it starts a line: write [ ] Pass [ ] Fail inline and every previewer shows dead literal text the tester has to edit by hand. This applies to Result's three outcomes, each step checkpoint, and the Environment and Setup boxes alike: one per line, no exceptions, never side by side to save vertical space.
Observable, not internal. Write what the tester sees or measures, not state they have no way to inspect.
Concrete and reproducible. Real values and exact steps, so not "test the login" but "enter bad@example.com / blank password, click Sign in".
Skipped is a first-class outcome. Result offers Pass, Fail and Skipped, one per line, and Notes carries the reason. A case the tester couldn't run, because the environment was missing, a dependency was down, or they ran out of time, has to be distinguishable from one nobody reached; a plan that comes back with silent blanks tells the next reader nothing.
Write the whole plan in the procedural register. A tester reads it while doing something, often against a clock, so the plan is written in ASD-STE100 Simplified Technical English throughout: Goal, Setup, Reset, Steps, checkpoints and Not covered alike. One instruction per sentence. Procedural sentences 20 words or fewer, descriptive sentences 25 or fewer. Active voice, present tense, and name the actor ("the app redirects to /login", not "a redirect occurs"). Keep the articles. No metaphor, idiom, or word with a second meaning. Prefer short sentences and bullet sublists over paragraphs. Pick one term per thing and keep it for the whole plan, so if the setup calls it the cart, a later step does not call it the basket, and a checkpoint does not call it the order. This is the rule that costs the most attention and saves the most: a tester who has to work out that two words mean one thing stops trusting both. The rule is scoped to one plan; a different document may use different words.
Honest about gaps. List what the plan can't verify under Not covered, including any dimension you deliberately skipped, rather than pretending coverage.
**Every command gets its own ```sh code block.** Never inline a terminal command in prose or a table cell, and never stack multiple commands in one block, so the tester can copy each one with a single click of the previewer's copy button. When commands must run together, chain them with && on one line inside a single block so one copy-paste runs the whole sequence.
Every API endpoint gets a runnable curl. Whenever a case or check exercises an HTTP endpoint, include the exact curl invocation in its own ```sh block rather than describing the request in prose. Spell out the method, full URL (with the local base URL or a $BASE_URL that **Environment** defines), every required header, and a concrete JSON body with real sample values, copy-paste-ready, with no <placeholders> the tester has to guess at. Use -i (or -s -w '\n%{http_code}\n') when a checkpoint covers a status code. This is the single biggest speedup in a QA pass: the tester runs the request instead of reconstructing it.
5. Run the automated checks yourself
Before handing off, actually run the agent-verifiable checks you split out in Derive the test dimensions, meaning terminal commands, endpoint hits, and return-value assertions, and record each outcome in the plan's Automated verification section (✅ passed with what the output confirmed, ❌ failed with the actual output). For anything you hit over HTTP, paste the exact curl you ran in its own ```sh block so the human can re-run or adapt it without rebuilding the request. This is the one part of the plan the agent completes, not the human. If there's no shell/filesystem, say so and leave the section for the human to fill.
Two commands you do not run, ever:
- Anything that destroys or rebuilds state, such as
*:destroy, *:reset, a teardown-and-rescaffold, a database drop, or a clean that wipes a build. This includes every scenario's own Setup and Reset block: those are written for the human to run, and the agent never executes them. Describe them; don't perform them. You are writing a plan about an environment, not administering one, and a QA agent that resets state can wipe the very build the human was about to test.
- A gate that a prior step in this session already ran green, meaning the test, build, lint, or verify chain that just passed. Record what it was and that it passed; re-running it produces the same answer at full price, and it is the most common way this step becomes the most expensive one in a pipeline. Re-run only if the change under test is that gate, or if something has modified the tree since.
Both rules have the same shape: inspect what exists, don't reproduce it. If you need built artifacts to write good cases, read the ones that are already there.
6. Hand off
Write this section in the procedural register: one instruction per sentence, active voice, present tense, no metaphor.
Tell the user the file path and give a one-line summary: how many scenarios and manual cases (and how many 🔴 critical), plus the automated-verification result (e.g. "2 scenarios, 6 manual cases, 2 critical · 6 automated checks ran, all green"). Suggest they run the manual plan in a fresh checkout/build, scenario by scenario, resetting only between scenarios. Don't mark any manual case as passed yourself, because those are the human's to execute; the agent only fills the Automated verification section.
Notes
- Scope of shell use. qakit runs the shell only to read the change and to run the project's own verification checks:
git diff/git log to ground the plan, and the automated checks from Run the automated checks yourself (the project's test, lint, and build commands). Every command it runs is echoed in the plan's Automated verification section, so the user sees exactly what ran. It does not fetch remote code, touch credentials, run anything destructive, or re-run a gate that already passed this session; see the two hard exclusions in Run the automated checks yourself. If a verification step would modify state or need elevated access, describe it for the human instead of running it.
- Manual only. qakit's sole output is a manual QA plan for a human to execute, and it never writes or runs unit/integration/E2E tests. Automated testing belongs to a test-suite skill (testkit when it's installed); if that's what the user wants, name that plain next step rather than assuming a particular skill is installed.
- No filesystem or shell? You can't write the file or read a diff. Instead ask the user to paste the change or describe the feature, then print the finished plan as a codeblock with the canonical
docs/qa/qa-<feature-slug>-YYYY-MM-DD.md path for them to save themselves.
1---2name: qakit3description: Generate a step-by-step manual QA and test plan for a feature just implemented, grounded in the actual code changes, and save it to docs/qa for a human to run. Use when a coding session wraps and you want to hand-test the result, or the user says "write a QA plan", "make a manual test plan", "how do I test this", "generate a testing plan for this feature", or runs /qakit.4license: MIT5---67# qakit89Turn a feature an AI agent just implemented into a **manual QA plan a human can actually run**, with concrete steps, verification checkpoints inline, and pass/fail/skip boxes, grounded in what the code actually changed rather than a generic checklist. The plan is written to `docs/qa/` so a person can walk it top to bottom and sign off on the feature by hand.1011This is **manual** QA, meaning steps that genuinely need a human to perform and judge (click through a flow, read a screen, feel out the UX), not checks a machine can do on its own. The value is a disciplined, diff-grounded plan: what to test, in what order, with what setup, and how to know it passed, focused on the things that *can't* be verified without a human eye.1213Anything an AI agent or script can confirm on its own, such as running a terminal command and reading its output, hitting an endpoint, or asserting a return value, does **not** belong in the human's checklist. The agent runs those itself and reports the results in an **Automated verification** section at the end of the plan, so the human sees them confirmed without re-running them by hand.1415The plan is organized around **setup**, not around dimensions. Setup is what a manual QA pass actually costs: reseeding data, logging in, getting the app into a particular state. A plan that makes the tester rebuild the same state five times because five cases each restate it is a worse plan than one with fewer, fatter cases.1617## When this fires1819The user finishes building something and wants to verify it by hand: "write a QA plan", "manual test plan", "how do I test this feature", "give me a testing checklist", "/qakit", or a bare "QA this" after a coding session. qakit produces a plan a **human** runs, and it never writes or runs test code. If the user wants *automated* tests (unit, integration, E2E), that's a separate concern for a test-suite skill; say so and don't produce a manual plan for it.2021## Procedure2223### 1. Scope the feature24Ground the plan in what was actually built, because a generic plan is worthless. Gather, in order of preference:2526- **The session context**, meaning what the user asked for and what you implemented this session. When you built the feature yourself, this is your best source and it costs nothing: you know its entry points and its failure modes better than the diff shows them.27- **The change**, when a repo is present: `git diff --stat HEAD` and `git log --oneline -10` to see which files and commits are in scope. A QA plan is written at the level of *behavior* (endpoints, screens, flags, commands, states) rather than lines, so read full diffs only for the files that carry behavior you can't already name: a route or handler, a form, a CLI entry point, a migration, a config default. Skip lockfiles, build output, and vendored directories entirely, and don't read a full diff for a file whose behavior the session already told you about.28- **The user**, only if intent is still unclear. Ask what the feature is *supposed* to do and how they normally exercise it (URL, command, screen, credentials), in one focused question, not an interview.2930Write down, for yourself: the feature's intended behavior, its entry points, and its dependencies (services, data, auth, config). Everything downstream hangs off this.3132### 2. Derive the test dimensions33Walk every dimension below and generate candidate cases for each one that applies to the feature. Skip a dimension only when it's genuinely irrelevant, and say so under *Not covered* in the plan so the tester knows it was considered, not forgotten:3435- **Happy path.** The feature used exactly as intended, the primary flow end to end.36- **Edge & boundary.** Empty input, max/min values, off-by-one boundaries, unusual-but-valid states, duplicates, unicode/large payloads.37- **Negative / error handling.** Bad input, missing/expired auth, unavailable dependencies, network failures; assert it fails *gracefully* with a clear message and no corruption.38- **Regression.** Nearby behavior the change could have broken (shared components, the prior flow, adjacent features).39- **Security & permissions.** Role/ownership checks, access to another user's data, injection-style input, secrets not leaked in logs or responses.40- **Data & state.** Persistence after reload/restart, idempotency, correct create/update/delete, no orphaned or stale state.41- **Concurrency & timing.** Simultaneous actions, double-submit, race conditions, retries, slow responses.42- **Compatibility.** Where there's a UI: target browsers/OS/devices, responsive/mobile layout, dark mode.43- **Accessibility.** Keyboard navigation, focus order, screen-reader labels, and contrast, where there's a UI.44- **Performance.** Responsiveness under realistic or large data volumes; no obvious slowdown or leak.45- **Usability / UX.** The feel a human must judge: clear copy, sensible defaults, discoverable actions, helpful empty/loading states.4647Prioritize: tag each case with one of three tiers, each carrying an emoji so the tester reads urgency at a glance:4849- 🔴 **Critical.** Must pass to ship; a failure blocks release.50- 🟡 **Normal.** Should pass; a failure is a real bug but not a blocker.51- 🟢 **Low.** Nice-to-have, polish, or edge cases with minor impact.5253Don't pad, because one clear check per behavior beats ten redundant ones. Scale the count to the feature's surface area and risk. What you have at the end of this step is a flat pile of candidate cases; the next step decides which of them are actually separate cases.5455**Split human-only from agent-verifiable.** As you generate cases, sort each one: does confirming it *require a human* (visual judgment, real interaction, UX feel), or can an agent/script confirm it by running a command and reading output? Only the human-only cases reach the plan's test cases. Run the agent-verifiable checks yourself and record their outcomes in the **Automated verification** section, and never list a command-and-check-output step as a manual case for the human to run by hand.5657### 3. Group the cases into scenarios58A **scenario** is one setup, every case that can run on top of it, and one reset at the end. Sort the candidate cases by the starting state each one needs, then:5960- **One scenario per distinct starting state.** Two cases that need the same state belong in the same scenario, always. The tester sets up once, runs the whole scenario, resets once.61- **Merge cases that share a setup *and* a flow.** If confirming three behaviors just means walking one flow and looking at three things along the way, that's *one* case with three checkpoints, not three cases that each restate the same six steps. Failure isolation comes from the checkpoint, not from the case: an unticked box points at exactly one behavior just as precisely as a failed case did, and costs the tester nothing to reach. **This is a merge, not a relocation**, so the merged case ends up with three checkpoints, not with every assertion the three cases spelled out between them, stacked into a column of boxes. The checkpoint rules in [Write the plan file](#4-write-the-plan-file) are what stop the squeeze from simply reappearing one level down.62- **Split only when the flows genuinely diverge**, meaning a different entry point, or a case that leaves state the following case can't tolerate.63- **Order within a scenario: read-only first, state-mutating next, destructive last.** A case that deletes the record every other case needs goes at the end, or earns its own scenario.64- **Fewest scenarios that still cover the dimensions.** A new scenario has to justify itself with a genuinely different starting state; "it feels like a different topic" doesn't.6566Name a scenario for the state it starts from ("Fresh tenant, no data", "Existing user with 200 orders", "Feature flag off") rather than for its topic ("Validation", "Error handling"). The name is what tells the tester whether they're already in the right state.6768Number cases within their scenario: `TC-<scenario>.<case>`, so `TC-2.3` is the third case of Scenario 2.6970**Everything true for the whole plan is not scenario setup.** Branch, build, base URL, credentials, auth token, feature flags, and launch command go once in **Environment** at the top. Each scenario's **Setup** carries only what's specific to that scenario. This is the split that keeps setup connected to the cases that need it.7172### 4. Write the plan file73Write to `docs/qa/qa-<feature-slug>-YYYY-MM-DD.md`, using a short lowercase kebab-case feature slug and the plan's ISO creation date (for example, `qa-login-throttle-2026-07-23.md`). Keep that date stable on later edits; record an updated date inside the document when useful. Create `docs/qa/` if it doesn't exist. Update an existing QA plan for the same artifact in place. For a genuine same-day collision between distinct plans, make the slug more specific; only as a last resort insert a sequence immediately before the date (`qa-login-throttle-02-2026-07-23.md`).7475Structure the file like this (the outer fence below is shown with four backticks only so the inner ```sh blocks display; the real file uses normal triple-backtick fences):7677````markdown78# QA Plan: <Feature name>7980_Generated <date> · against `<commit sha>` · covers <brief scope>_8182## Summary83- What the feature does, in one short sentence.84- What "working" means, in one short sentence.8586## Environment87True for the whole plan. Do this once, before Scenario 1.8889- Branch / build under test90- Base URL, credentials, and how to obtain any auth token the calls need91- Feature flags / config9293Launch with:9495```sh96<launch command>97```9899- [ ] Environment ready100101## Test cases at a glance102103Priority legend: 🔴 Critical · 🟡 Normal · 🟢 Low104105| # | Scenario | Test case | Priority |106|------|----------|-----------|----------|107| TC-1.1 | 1: <starting state> | <short title> | 🔴 Critical |108| TC-1.2 | 1: <starting state> | <short title> | 🟡 Normal |109| TC-2.1 | 2: <starting state> | <short title> | 🟢 Low |110111## Scenario 1: <starting state>112113**Setup.** Run once, for every case in this scenario.1141151. <setup action>116117```sh118<setup command>119```120121- [ ] Setup complete122123### TC-1.1: <short title> · 🔴 Critical124125**Goal.** <one line: what this case proves>126127**Steps**1281291. <concrete action a human takes>130 - [ ] <one judgment the tester stops to make right here>131 - <what to look at, when the judgment needs a guide; a plain bullet, not a checkbox>132 - <another thing taken in at the same glance>133 - [ ] <a second judgment, only when it's a genuinely separate look>1342. <next action; a command goes in its own block>135136 ```sh137 <command to run>138 ```139140 - [ ] <what the output or screen must show>141142**Result**143144- [ ] Pass145- [ ] Fail146- [ ] Skipped147148**Notes.** _what actually happened on a fail; why it was skipped_149150### TC-1.2: <short title> · 🟡 Normal151...152153**Reset.** Run after every case above, before moving to Scenario 2.154155```sh156<reset command>157```158159## Scenario 2: <starting state>160...161162## Automated verification (by AI agent)163_Checks the agent ran itself. No action needed from the tester; listed here for context and sign-off._164165Commands run (one per block; chain with `&&` when they must run together):166167```sh168<command 1>169```170171```sh172<command 2>173```174175- ✅ <command 1> → <what the output confirmed>176- ✅ <endpoint / assertion checked> → <result>177- ❌ <anything that failed, with the actual output> _(if any)_178179## Not covered / needs human judgment180- <anything that can't be scripted: visual polish, UX feel, external integrations, timing>181- <dimension deliberately skipped, and why>182183## Overall result184_Tick one when you finish the run._185186- [ ] Pass: every case passed187- [ ] Fail: at least one case failed188- [ ] Partial: cases were skipped or not reached189````190191Rules for good cases:192- **Never ask the tester to transcribe something you already know.** The header stamp carries the date and the exact commit the plan was written against, so fill both in yourself from `git log` and don't leave a blank table for a human to copy a sha into. The only thing the plan asks of the tester is the one judgment a machine can't make: the overall verdict. If they end up running against a different build than the stamp, that belongs in a case's **Notes**, not in a field every plan carries empty forever.193- **Overall result goes last, at the foot of the file.** The tester ticks it when the run ends, and the run ends at the bottom of the plan. A verdict box near the top asks them to scroll back through every case they just finished, so it stays unticked.194- **Fixed case body, always these four parts in this order:** **Goal**, **Steps**, **Result**, **Notes**. No case drops one, no case invents a fifth. A tester should be able to jump to any case in any plan and find the same shape.195- **Goal is one line and says what the case *proves***, not what it does: "an expired token can't reach another tenant's orders", not "test the orders endpoint".196- **Verification lives under the step that produces it.** Never a separate expected-results list at the bottom of the case: a step is followed immediately by its own `- [ ]` checkpoints, so the tester ticks as they go instead of holding five expectations in their head and reconciling them at the end. A step with nothing to observe simply has no checkpoints.197- **One checkpoint per *judgment*, not per assertion.** A checkpoint is one thing the tester stops to decide, not one fact the feature asserts. The test to apply: *would they plausibly tick one box and leave the next one unticked?* If they'd settle both in the same glance, it is one checkpoint. Granularity past the tester's attention doesn't buy precision, it fabricates it: nobody makes seven independent judgments while scrolling a page once, so seven boxes come back rubber-stamped and are then read as seven confirmations they never were.198- **Split different judgments; join one judgment applied across a set.** "The footer's headings, links, separator rule and copyright are all legible" is a single look at a single region, so one box. "The icon changed to the moon" and "storage now holds `dark`" are two places to look, so two boxes. The word "and" is not the test; whether the tester's eye has to move is.199- **Detail belongs *under* a checkpoint, as a plain unticked sub-list.** What to look at is worth spelling out, because it's the difference between "check the page" and knowing the pricing table's featured plan is the thing most likely to vanish. It just isn't worth a tick each:200201 ```markdown202 1. Set the state to `light`. Scroll the whole page top to bottom at ≥1280px.203 - [ ] Every block reads correctly, with nothing illegible and nothing invisible on its own background204 - navbar: sticky background opaque; logo, links and control legible205 - hero: heading, sub-copy, both buttons; primary label against the primary fill206 - pricing-table: the toggle in both positions; the featured plan distinguishable; check marks207 - footer: headings, links, separator rule, copyright208 ```209210 Failure isolation survives the collapse, because **Notes** already exists and a failing checkpoint needs a note regardless. That asymmetry is the goal: a plan that is cheap to run when it passes and only gets expensive where it fails.211- **A repeated pass gets one checkpoint plus whatever is new.** When a second variant re-runs a sweep the tester already performed (the other palette, the second browser, the next breakpoint, the swapped preset) never enumerate the same items again. **Never write "as above, in `<variant>`".** A line that carries no observation of its own is a loop counter the human ticks by hand:212213 ```markdown214 2. Set the state to `dark`. Scroll the page again.215 - [ ] The same sweep is clean in dark216 - [ ] Nothing is pure-black-on-dark where a muted token was intended217 ```218- **Every checkbox owns its own line.** A `- [ ]` renders as a *clickable* checkbox only when it starts a line: write `[ ] Pass [ ] Fail` inline and every previewer shows dead literal text the tester has to edit by hand. This applies to Result's three outcomes, each step checkpoint, and the Environment and Setup boxes alike: one per line, no exceptions, never side by side to save vertical space.219- **Observable, not internal.** Write what the tester sees or measures, not state they have no way to inspect.220- **Concrete and reproducible.** Real values and exact steps, so not "test the login" but "enter `bad@example.com` / blank password, click Sign in".221- **Skipped is a first-class outcome.** **Result** offers Pass, Fail *and* Skipped, one per line, and **Notes** carries the reason. A case the tester couldn't run, because the environment was missing, a dependency was down, or they ran out of time, has to be distinguishable from one nobody reached; a plan that comes back with silent blanks tells the next reader nothing.222- **Write the whole plan in the procedural register.** A tester reads it while doing something, often against a clock, so the plan is written in ASD-STE100 Simplified Technical English throughout: Goal, Setup, Reset, Steps, checkpoints and Not covered alike. One instruction per sentence. Procedural sentences 20 words or fewer, descriptive sentences 25 or fewer. Active voice, present tense, and name the actor ("the app redirects to `/login`", not "a redirect occurs"). Keep the articles. No metaphor, idiom, or word with a second meaning. Prefer short sentences and bullet sublists over paragraphs. **Pick one term per thing and keep it for the whole plan**, so if the setup calls it the *cart*, a later step does not call it the *basket*, and a checkpoint does not call it the *order*. This is the rule that costs the most attention and saves the most: a tester who has to work out that two words mean one thing stops trusting both. The rule is scoped to one plan; a different document may use different words.223- **Honest about gaps.** List what the plan can't verify under *Not covered*, including any dimension you deliberately skipped, rather than pretending coverage.224- **Every command gets its own ```sh code block.** Never inline a terminal command in prose or a table cell, and never stack multiple commands in one block, so the tester can copy each one with a single click of the previewer's copy button. When commands must run together, chain them with `&&` on one line inside a single block so one copy-paste runs the whole sequence.225- **Every API endpoint gets a runnable `curl`.** Whenever a case or check exercises an HTTP endpoint, include the exact `curl` invocation in its own ```sh block rather than describing the request in prose. Spell out the method, full URL (with the local base URL or a `$BASE_URL` that **Environment** defines), every required header, and a concrete JSON body with real sample values, copy-paste-ready, with no `<placeholders>` the tester has to guess at. Use `-i` (or `-s -w '\n%{http_code}\n'`) when a checkpoint covers a status code. This is the single biggest speedup in a QA pass: the tester runs the request instead of reconstructing it.226227### 5. Run the automated checks yourself228Before handing off, actually run the agent-verifiable checks you split out in [Derive the test dimensions](#2-derive-the-test-dimensions), meaning terminal commands, endpoint hits, and return-value assertions, and record each outcome in the plan's **Automated verification** section (✅ passed with what the output confirmed, ❌ failed with the actual output). For anything you hit over HTTP, paste the **exact `curl` you ran** in its own ```sh block so the human can re-run or adapt it without rebuilding the request. This is the one part of the plan the agent completes, not the human. If there's no shell/filesystem, say so and leave the section for the human to fill.229230**Two commands you do not run, ever:**231232- **Anything that destroys or rebuilds state**, such as `*:destroy`, `*:reset`, a teardown-and-rescaffold, a database drop, or a `clean` that wipes a build. This includes every scenario's own **Setup** and **Reset** block: those are written *for the human to run*, and the agent never executes them. Describe them; don't perform them. You are writing a plan *about* an environment, not administering one, and a QA agent that resets state can wipe the very build the human was about to test.233- **A gate that a prior step in this session already ran green**, meaning the test, build, lint, or verify chain that just passed. Record what it was and that it passed; re-running it produces the same answer at full price, and it is the most common way this step becomes the most expensive one in a pipeline. Re-run only if the change under test **is** that gate, or if something has modified the tree since.234235Both rules have the same shape: **inspect what exists, don't reproduce it.** If you need built artifacts to write good cases, read the ones that are already there.236237### 6. Hand off238239_Write this section in the procedural register: one instruction per sentence, active voice, present tense, no metaphor._240241Tell the user the file path and give a one-line summary: how many scenarios and manual cases (and how many 🔴 critical), plus the automated-verification result (e.g. "2 scenarios, 6 manual cases, 2 critical · 6 automated checks ran, all green"). Suggest they run the manual plan in a fresh checkout/build, scenario by scenario, resetting only between scenarios. Don't mark any *manual* case as passed yourself, because those are the human's to execute; the agent only fills the Automated verification section.242243## Notes244- **Scope of shell use.** qakit runs the shell only to read the change and to run the project's own verification checks: `git diff`/`git log` to ground the plan, and the automated checks from [Run the automated checks yourself](#5-run-the-automated-checks-yourself) (the project's test, lint, and build commands). Every command it runs is echoed in the plan's **Automated verification** section, so the user sees exactly what ran. It does not fetch remote code, touch credentials, run anything destructive, or re-run a gate that already passed this session; see the two hard exclusions in [Run the automated checks yourself](#5-run-the-automated-checks-yourself). If a verification step would modify state or need elevated access, describe it for the human instead of running it.245- **Manual only.** qakit's sole output is a manual QA plan for a human to execute, and it never writes or runs unit/integration/E2E tests. Automated testing belongs to a test-suite skill (**testkit** when it's installed); if that's what the user wants, name that plain next step rather than assuming a particular skill is installed.246- **No filesystem or shell?** You can't write the file or read a diff. Instead ask the user to paste the change or describe the feature, then print the finished plan as a codeblock with the canonical `docs/qa/qa-<feature-slug>-YYYY-MM-DD.md` path for them to save themselves.
mimukit