Documentation
Choose a page shape from the reader's task. Covers writing, portable Markdown, diagrams, standards, guides, quick starts, tutorials, references, troubleshooting, and runbooks.
Diagrams
Show one relationship clearly using a small Mermaid diagram or a text tree for file layout.Documentation standards
Choose a page shape from the reader's task. Keep its contracts accurate when copied into a local context pack.Formatting
Keep Markdown portable across copied packs, with concise metadata and examples readers can execute.Guides
Document a task with prerequisites, ordered actions, an observable result, and fixes for known failures.Quick starts
Take a new reader to one working result in at most five steps, with executable commands and clear output.References
Describe caller-facing contracts precisely: inputs, defaults, outputs, failures, limits, and valid examples.Runbooks
Make repeatable operating procedures verifiable at each step, with explicit rollback and escalation paths.Standards authoring
Write normative rules with reasons, focused examples, and an honest account of automated and manual enforcement.Troubleshooting
Organize failures by recognizable symptoms, give a bounded fix, and show how to verify recovery.Tutorials
Teach through a bounded build: each step changes something the reader can inspect and explains one concept.Writing
Assign every page a reader task and keep contributor rules separate from product explanation.