# evildmp/diataxis-documentation-framework

A systematic approach to creating better documentation.

Repository: https://github.com/evildmp/diataxis-documentation-framework
Canonical: https://ross.abutalabs.com/products/diataxis-documentation-framework
Homepage: https://diataxis.fr
Language: Python
License: NOASSERTION
License Family: other
Topics: documentation
Last push: 2026-08-16T22:38:15+00:00

## Health v2 (maintenance only)
Score: 76/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 98, release rhythm 35, longevity 100
- inputs: {"age_days": 2352, "days_push": 17, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1208, forks 199 (observed 2026-08-28T04:03:59.629355+00:00)

## What it is
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
- artifact type: learning-resource
- maturity: stable
- function: documentation
- domain: documentation, developer-tools
- platform: -
- tags: diataxis, technical-writing, docs-as-code, methodology, framework, web-server

## Member repositories
- evildmp/diataxis-documentation-framework (main) score 76

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:59.629355+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:18:55.120772+00:00, confidence not recorded.
  - readme: https://github.com/evildmp/diataxis-documentation-framework (fetched 2026-08-28T04:03:59.629355+00:00, sha 1210717a471b)
  - homepage: https://diataxis.fr (fetched 2026-08-29T12:26:39.011677+00:00, sha 3b3b855dc11e)
- Data as of 2026-08-30T08:39:29.467469+00:00.