Implement Documentation Topic
Write a high-signal documentation topic using the Unified Frameworks for Technical Information Architecture.
Core Rules
- Establish context and prerequisites in the first two sentences (EPPO).
- Lead with the answer or primary assertion in the TL;DR and first paragraph (Pyramid Principle).
- Use explicit, semantic block labels (descriptive headers) for every 2-3 paragraphs (Info Mapping).
- Provide a clear "fail-state" or troubleshooting section (Minimalism).
- Do not mix intents: no deep theory in a How-to. If theory is required, use a Note or Deep Dive sidebar to maintain quadrant purity.
- Do not use "Next" or "Previous" as the only navigational cues (EPPO).
Procedure
- Quadrant check: identify the Diátaxis quadrant and follow its rhetorical rules. Use
references/templates.mdfor the matching template (Tutorial, How-to, Reference, or Explanation). Usereferences/anti-patterns.mdto avoid common failures for that quadrant. - EPPO initialization: every topic must stand alone. Start with a clear task- or concept-focused title and a context block ("This topic covers [X]. You should already understand [Y] and have [Z] installed.").
- Information mapping: chunk the body into units under 7 items; label headers by result or content (e.g., "Configuring the API" not "Configuration"); convert complex comparisons or steps into tables and lists.
- AI-first polish: ensure headers are descriptive for RAG indexing and provide a 1-2 sentence TL;DR at the top for LLM ingestion.
- If setting up a new docs site or choosing tooling, use
references/tooling-comparison.mdfor platform selection andreferences/versioning.mdfor versioning and changelog strategy. For a full Diátaxis rollout, usereferences/diataxis-implementation.md.
Rules
- The canonical theory lives in
content/research-documentation-frameworks.md; the references here are operational excerpts that link back to it.
Related Skills
research-documentation— audit before writing.review-documentation— review after writing.