diataxis-documentation

Technical documentation is classified into Tutorials, How-to Guides, Reference, and Explanation categories by the Diataxis framework to align content with reader intent. This ensures readers locate the exact information type they need.

Auditing existing product documentation involves classifying content against the Diataxis framework to check for type purity and structural correctness. This process evaluates boundaries, tone, and cross-links to maintain accuracy and consistency.

Tutorials and how-to guides should be separated when structuring technical documentation to maintain type purity. Tutorials focus on learning and motivation, while how-to guides provide direct steps to accomplish specific tasks.

Yes, the Diataxis framework applies to writing, reviewing, and auditing product documentation and onboarding materials. It classifies content to apply a consistent voice, style, and boundary discipline as materials evolve.

Maintaining cross-links and a consistent voice across documentation is best achieved by applying the Diataxis framework to enforce boundary discipline. This ensures accuracy and consistency as content evolves over time.