Meta tags:
author= Daniele Procida;
description= Diátaxis is a widely-adopted, pragmatic and systematic approach to thinking about and creating documentation.;
keywords= documentation, four, kinds, architecture;
Headings (most frequently used words):
diátaxis, contents,
Text of the page (most frequently used words):
#diátaxis (23), the (20), and (18), documentation (15), our (7), how (7), that (6), for (5), reference (5), explanation (5), tutorials (5), guides (5), light (5), content (4), users (4), quality (4), understanding (4), needs (4), dark (4), mode (4), contents (3), start (3), here (3), architecture (3), framework (3), four (3), applying (3), help (3), approach (3), systematic (3), this (2), when (2), should (2), been (2), contributors (2), around (2), they (2), need (2), them (2), has (2), love (2), principles (2), map (2), foundations (2), workflow (2), compass (2), way (2), maintainers (2), about (2), write (2), from (2), technical (2), translate (2), auto (2), page, copyright, daniele, procida, five, minutes, next, adam, schwartz, while, redesigning, became, north, star, information, weren, sure, where, new, piece, fit, consult, now, clearer, than, ever, both, readers, cloudflare, developer, docs, megan, sullivan, gatsby, recently, reorganized, open, source, was, resource, throughout, project, quadrants, helped, prioritize, user, goal, each, type, restructuring, made, easier, discover, resources, greg, frileux, vonage, allowed, build, high, set, internal, adding, proven, practice, its, have, adopted, successfully, hundreds, projects, section, explores, theory, more, deeply, sets, forth, underpin, these, pages, will, make, immediate, concrete, sense, best, get, started, with, after, reading, brief, primer, well, serving, value, creators, weight, easy, grasp, straightforward, apply, doesn, impose, implementation, constraints, brings, active, principle, helps, think, effectively, their, own, work, solves, problems, related, what, organise, style, ancient, greek, δῐᾰ́τᾰξῐς, across, arrangement, taxis, dia, identifies, distinct, corresponding, forms, places, relationship, proposes, itself, organised, structures, those, prescribes, approaches, form, emerge, into, your, language, thinking, doing, authoring, polski, english, back, top, news, updates, colophon, home, skip, expand, menu,
Text of the page (random words):
diátaxis contents menu expand light mode dark mode auto light dark in light mode auto light dark in dark mode skip to content diátaxis home start here applying diátaxis tutorials how to guides reference explanation the compass workflow understanding diátaxis foundations the map quality tutorials and how to guides reference and explanation colophon help translate diátaxis news updates back to top english en polski pl diátaxis a systematic approach to technical documentation authoring diátaxis is a way of thinking about and doing documentation help translate diátaxis into your language 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 from the ancient greek δῐᾰ́τᾰξῐς dia across and taxis arrangement diátaxis solves problems related to documentation content what to write style how to write it and architecture how to organise it as well as serving the users of documentation diátaxis has value for documentation creators and maintainers it is light weight easy to grasp and straightforward to apply it doesn t impose implementation constraints it brings an active principle of quality to documentation that helps maintainers think effectively about their own work contents the best way to get started with diátaxis is by applying it after reading a brief primer start here these pages will help make immediate concrete sense of the approach applying diátaxis tutorials how to guides reference explanation the compass workflow this section explores the theory and principles of diátaxis more deeply and sets forth the understanding of needs that underpin it understanding diátaxis foundations the map quality tutorials and how to guides reference and explanation diátaxis is proven in practice its principles have been adopted successfully in hundreds of documentation projects diátaxis has allowed us to build a high quality set of internal documentation that our users love and our contributors love adding to greg frileux vonage at gatsby we recently reorganized our open source documentation and the diátaxis framework was our go to resource throughout the project the four quadrants helped us prioritize the user s goal for each type of documentation by restructuring our documentation around the diátaxis framework we made it easier for users to discover the resources that they need when they need them megan sullivan while redesigning the cloudflare developer docs diátaxis became our north star for information architecture when we weren t sure where a new piece of content should fit in we d consult the framework our documentation is now clearer than it s ever been both for readers and contributors adam schwartz next start here diátaxis in five minutes copyright daniele procida on this page diátaxis contents
|