Reference Mirrors the Thing
Organize reference material so readers can scan from product structure to documentation structure without translation.
Reference is a map, not a tour. The reader is not asking you to guide them through a workflow. They are asking you to expose a fact in a stable, scannable place. Diataxis makes reference distinct from explanation for exactly this reason. Explanation can interpret. Reference should mostly describe. Minimalism sharpens the standard: neutral labels, exact names, and as little narrative as possible. Docs-as-code turns that discipline into maintainable files aligned with schemas, objects, resources, or commands. Mirror the product If a method belongs to a class in a module, the docs should show the same relationship. Remove interpretation Facts…
Sign up free — one personalized lesson every day, matched to your role and goals.
Already have an account? Sign in