Menu

Diátaxis
📰
0

Diátaxis

Hacker News·Diátaxis·about 1 month ago
#nad6pc7j
Reading 0:00
15s threshold

Back to top Toggle table of contents sidebar 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 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.…

Continue reading — create a free account

Join HashtagPLUS to read full articles, follow hashtags, vote, and join the conversation.

Read More