Diátaxis
diataxis.fr · 346 words · saved by 7 readers
Diátaxis is a widely-adopted, pragmatic and systematic approach to thinking about and creating documentation.
A systematic approach to technical documentation authoring. Diátaxis is a way of thinking about and doing documentation. It prescribes approaches to content, architecture and form that emerge from a systematic approach to understanding the needs of documentation users. Diátaxis identifies four distinct needs, and four corresponding forms of documentation - tutorials, how-to guides, technical reference and explanation. It places them in a systematic relationship, and proposes that documentation should itself be organised around the structures of those needs. Diátaxis solves problems…
saved by
related reading
- Diátaxis as a guide to work - Diátaxisdiataxis.fr
- Getting Started • Zettelkasten Methodzettelkasten.de
- The Surprising Power of Documentationnews.ycombinator.com
- How Stripe creates the best documentation in the industrymintlify.com
- Writing a good design documentnews.ycombinator.com
- A Beginner’s Guide to the Zettelkasten Method | Zenkitzenkit.com
- Artifactsartifacts.fyi
- Design Docs at Googleindustrialempathy.com
- Understanding Technical Design Document and Writing Guidekimi.ai
- Potluck: Dynamic documents as personal softwareinkandswitch.com
- A Hierarchy First Approach to Note Takingkevinslin.com
- Technical Design Document Templatenoteplan.co