Skip to Main Content
Talk Intermediate CC BY-SA 4.0 First Talk

Why Your Docs Confuse Everyone, and How Diátaxis Framework Fixes It

Proposal status is Rejected
Session Description

Most open source docs confuse people for a structural reason, not a writing one. A single page tries to teach a beginner, walk an expert through one task, list every config flag, and explain the design rationale all at once, and it serves none of those readers well.

You have seen this. A "getting started" guide that suddenly dumps forty configuration options. A tutorial that stops to explain architecture you do not need yet. A reference page that assumes you already finished a tutorial nobody linked. The reader bounces, and on a FOSS project, that reader was often a would-be contributor.

Diátaxis is the framework that fixes this by separating docs into four modes, each answering a different need. This talk explains the four modes, then proves the point live: I take a well-known open source project's docs, diagnose which pages are mixing modes and why readers get stuck, and restructure a section on stage.

What this talk covers:

  • The four documentation modes and the specific reader need each one serves

  • How to spot a page that is silently doing two jobs at once

  • A live teardown and re-sort of a real FOSS project's docs

  • A repeatable audit you can run on your own docs the same week

  • Why clean separation lowers the barrier for first-time contributors

This is for anyone who writes or maintains docs for an open source project, from solo maintainers to teams, and for contributors who came in through writing rather than code.

Key Takeaways
  • Name what each page in your docs is actually doing, using the four-mode model

  • Find the pages where two jobs are fighting and split them

  • Run a full Diátaxis audit on your own docs site, the same week

  • Restructure a confusing page so every reader gets a clean path through it

References

Session Categories

Engineering practice - productivity, debugging
Talk License: CC BY-SA 4.0

Which track are you applying for?

Documentation & Technical Writing

Speakers

Pritesh Kiri
Pritesh Kiri Developer Relations Engineer | Harness

Pritesh is the DevRel Engineer at Harness and community manager and maintainer of the LitmusChaos Community. He is also the Head of Community at ReactPlay, leading the ReactPlay Bangalore chapter. He has a strong background as a Developer Advocate, leading tech communities and fostering open-source contributions.

Pritesh organizes workshops and meetups and creates video/blog content on MCP, Agents, and AI.