Documentation Principles

This lab compares Diátaxis documentation modes and shows how a visual can either explain a concrete example or decorate it without adding structure.

Current mode: Explanation. Current visual style: functional. Example: Session recap pipeline. A teammate needs a reusable model of how activity becomes a recap.

Current Example Details

• claim: Activity events become a recap through explicit stages.
• vocabulary: Event, stage, recap, and reader model are named up front.
• thread: The same session recap pipeline appears in every section.
• tradeoff: Rejected alternatives explain why recap stages are explicit.

Documentation Principles

• central claim: Open with the main idea.
• working vocabulary: Define recurring terms before they carry the argument.
• threaded example: Use one concrete scenario, then keep returning to it.
• functional visual: Show the actual transformation, not decoration.
• why and tradeoffs: Explain why the structure exists.