gezel Gezel Handboek

Technical Documentation

Generate a coherent documentation set from a codebase, organized by the Diataxis model (tutorials, how-to guides, reference, explanation), with cross-links and a coverage pass.

How it runs

#StepWho runs itWhat happens
1Inventory the documentation surfaceResearcherMap readers, public interfaces, source evidence, existing coverage, and gaps.
2Design the documentation setDeveloperChoose the right document type for each reader need and lock verification criteria.
3Author, link, and verify the docsCopywriterWrite the planned pages, validate examples and links, and expose the complete set through one index.
4Evaluate the deliverableDeveloperIndependently grade the observable deliverable and route it to finish, repair, or user escalation.
5Repair the deliverableCopywriterFix only the concrete gaps from the latest independent review.
6FinishDeveloperAll deterministic and reviewer criteria passed.
7Escalate unresolved concernsDeveloperThe bounded repair loop ended without a defensible pass.

Say something like "write docs for this" or "generate documentation" or "document this feature" or "create a tutorial" or "write a how-to" or "explain this module" or "docs for this project" in chat to start it.

Watch this article as a slideshow