Doc Run Manual Screenshots
Table of Contents
1. When to use this skill
When a manual chapter is content-complete (per compass-doc-add-entity-chapter)
but still carries [SCREENSHOT NEEDED] placeholders that need turning
into real, correctly-cropped images before the chapter is ready for
human review.
2. How to use this skill
Run How do I capture screenshots for a manual chapter? end to end:
- Its Prerequisites section — build if needed, then ready the environment (fresh database, Acme Corporation provisioned by you, not the user), then confirm the chapter itself already builds. Non-negotiable, in order — never capture against a build or database that predates the entity's current state.
- Its capture/wire-in sections — a
test_scenariorecording one step per placeholder, each capture taken by hand and recorded in the step's*** Result, then cropped and named per convention, wired into the chapter, both the PDF and the HTML rebuilt, then handed off for human review — this skill's job ends at a chapter with real images in place, not at marking the task DONE.
Capture is blocked until a client exists again. The runner that took these captures went with the Qt client. Do not stage the capture steps or claim a chapter is screenshot-complete while the recipe's blocking note stands; say so instead.
3. Recipes
- How do I capture screenshots for a manual chapter?
- How do I ready up an environment?
- How do I document an entity? — the recipe this one follows on from.
4. Reference
- Archetype: doc_test_scenario.org.mustache — the
test_scenariodoc shape. - QA Validation Runner: in-app test tracking for the multi-worktree fleet — the panel this skill drove, before the Qt client was removed.
- compass-code-run-feature-test — sibling skill sharing the same environment-readying recipe, applied to feature verification instead of screenshot capture.