Diátaxis: A Systematic Framework for Technical Documentation

Procida, D. (2017). Diátaxis: A Systematic Framework for Technical Documentation: A Systematic Framework for Technical Documentation.

Type

Web resource

Intellectual base

Web

Year

2017

Link

https://diataxis.fr/

Cited from

literature_literary_theory

Cited by

2 citations across 2 artifacts.

Each citation links to the sentence it supports in the citing article.

Primes

• Fabula And Syuzhet
  • UI onboarding and progressive disclosure. A product has a fixed feature set and architecture (fabula); the order in which a new user meets features is a syuzhet design problem with very different optimization criteria. Technical writing. API reference (near-fabula: exhaustive, indexable) versus tutorial (heavy syuzhet: selective, ordered for learning) are two presentations of one underlying library.

    This sourceDistinguishes tutorial, how-to, reference, and explanation as four distinct documentation types serving different needs — reference (information-oriented, indexable) versus tutorial (learning-oriented, ordered) as separate projections of one underlying product.

Mechanisms

• Documentation Navigation Map
  • A technical writer builds a Documentation Navigation Map, organizing the corpus after the pattern of a documentation framework that separates tutorials, how-tos, reference, and explanation.

    This sourceDiátaxis documentation framework (n.d.).

Verification

This reference passed the adversarial substantiation pipeline: it was checked to exist and to support the claim it is attached to. See how references were verified.

Registry ID ref:e562c5a55e44 · see in the full table