evildmp/diataxis-documentation-framework resource

Health v2 · maintenance only

Flags: no_releases no_license

Adoption not part of the score

1208 stars · 199 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

Diátaxis is a systematic framework and methodology for organizing and authoring technical documentation, published as a website at diataxis.fr. It identifies four documentation forms - tutorials, how-to guides, reference, and explanation - and prescribes how to structure content around user needs.

Use cases

• structure my project's documentation
• decide what tutorials vs how-to guides vs reference to write
• improve documentation quality and organization
• learn a systematic approach to technical writing
• reorganize messy docs into a clear architecture
• train my team on documentation best practices

When to choose

• you are writing or restructuring documentation for software or technical products
• you want a lightweight, widely-adopted documentation framework without tooling constraints

When to avoid

• you need a documentation generator or static site tool rather than a methodology
• you need executable software - this is a guide/framework, not a tool

Facets

learning-resource · maturity stable

documentation documentation developer-tools diataxis technical-writing docs-as-code methodology framework web-server

Member repositories

For agents

markdown · JSON · MCP: product_card(name="evildmp/diataxis-documentation-framework")