python / python/docs-community

Diátaxis: Where are we?

Open
#33 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc:styleguide task
Dominant language
Makefile
Stars
55
Forks
26
PR merge metrics
No merged PRs in 30d

Description

There seems to be general consensus that diátaxis is a great theoretical model for structuring documentation.
However, using it – restructuring Python's docs – is a monumental task that needs some planning upfront.
@AA-Turner mentioned on the recent meeting that it would be good to start by charting the starting point: where on the Diátaxis chart do individual sections of the docs fall?
With that info we should be able to start planning where they should fall, and restructure/rewrite accordingly.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Diátaxis model linked in the issue and the current structure of Python’s documentation. Inventory the individual documentation sections and record where each falls on the Diátaxis chart; the work is done when that starting-point map is available for planning restructuring and rewriting.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.