Doc Add Entity Chapter
Table of Contents
When to use this skill
When a reference-data entity needs a user-manual chapter — a new entity just commissioned through codegen, or an existing entity whose chapter is missing or badly out of date. Covers the whole authoring arc: domain grounding, thesis-structured prose, screenshot placeholders, capturing and cropping the real screenshots, and wiring the chapter into the manual — ending with a chapter ready for human review.
How to use this skill
- Ask the user for the domain-knowledge source if they haven't
already named one — which hub note under
doc/knowledge/domain/(or external notebook) the chapter's conceptual section should summarise. Do not proceed to drafting without this; see How do I document an entity?§"Gather the domain-knowledge source" for why this can't be skipped or guessed. - Write the chapter by following How do I document an entity? in full:
scaffold the chapter file, follow the thesis structure (Abstract →
Overview → domain-concepts section in PhD-thesis prose → standard/
identity → list window → detail dialog → editing/history →
shell/CLI or an explicit note that they don't exist yet →
Conclusion → See also), segue every section into the next, insert a
[SCREENSHOT NEEDED]placeholder with a# Capture:instruction for every dialog/window referenced, wire the chapter intouser_manual.org, and build to validate. Stop when the recipe says to stop: a chapter that reads correctly and compiles, but has no real screenshots yet. - Capture the screenshots using the doc-run-manual-screenshots skill:
confirm the environment (build, fresh Acme-provisioned database)
before touching placeholders, scaffold a
test_scenariowith one step per placeholder, run it through the QA Validation Runner (falling back to a manual desktop screenshot for any step blocked by a modal dialog — capture that gap separately rather than working around it in the scenario), crop each raw capture to just the dialog or window, name it per the plural/singular convention, wire the real images and captions into the chapter, and rebuild the manual to confirm every figure resolves. - Hand off for human review. The skill's job ends here — do not mark the underlying task DONE and do not merge; the chapter is content-complete and image-complete, but still needs a human read for prose quality, factual accuracy against the entity's actual shipped fields, and screenshot correctness (right data, right crop, right caption).
Recipes
- How do I document an entity? — chapter structure, prose tone, domain grounding, screenshot placeholders, manual wiring.
- How do I capture screenshots for a manual chapter? — test scenario, capture, crop, rename, wire in; wrapped by the doc-run-manual-screenshots skill step 3 uses.
Reference
- Currency Pairs — the most recently authored chapter and the exemplar both recipes above point to.
- ORE Studio User Manual — the master document every chapter is wired into.
- QA Validation Runner: in-app test tracking for the multi-worktree fleet — the panel the second recipe drives.