documentation-writing

The four-type documentation system structures technical writing into distinct formats: Tutorial, How-to, Reference, and Explanation. It enforces a single documentation type per file to ensure consistent, high-quality output for software projects.

A tutorial teaches users by building a complete, real-world example, while a how-to guide provides goal-oriented, step-by-step instructions to achieve a specific outcome. You must select and adhere to only one type per document.

Use a reference document to deliver precise API, CLI, or configuration details in a stable layout. Use an explanation document to add context, rationale, and design decisions that inform deeper understanding.

No, the system enforces a one-type rule per document. You must separate API references and tutorials into different files, ensuring each document maintains a clear, focused structure across software projects.

To structure a README consistently, select a single documentation type from the four-type system and compose a focused entry. Apply clear sectioning based on whether the file is a Tutorial, How-to, Reference, or Explanation.