Choose Document Type

DOCS-CHOOSE-DOCUMENT-TYPE

Summary

Pick the dominant document mode before editing so the page serves one reader task well. Link out to secondary modes instead of blending tutorial, reference, decisions, and changelog.

Rule

Choose the document type before editing.

Why

A page that mixes tutorial, reference, explanation, decision record, and changelog work makes every reader pay for every mode. Choosing the document type first keeps a README task-first, a reference page precise, and an ADR focused on the decision instead of blending all three.

Helps

  • Keeps docs navigable and prevents local edits from expanding into accidental page rewrites.

Limits

Some pages need a small blend, such as a README with a short concept note. Pick the dominant mode and move deeper reference or decision detail behind links.

Agent Instruction

Choose the document type before editing because a page that mixes tutorial, reference, explanation,
decision record, and changelog work makes every reader pay for every mode.

Mechanisms

Supported by doc-type review, page outlines, README/reference/ADR templates, and links that move secondary modes to the right layer.

References