python / python/docs-community
Diátaxis: Where are we?
Personne n'a encore pris cette issue.
- Langage dominant
- Makefile
- Étoiles
- 55
- Forks
- 26
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner le modèle Diátaxis lié dans l’issue et la structure actuelle de la documentation de Python. Dressez l’inventaire des différentes sections de la documentation et indiquez où chacune se situe sur le diagramme Diátaxis ; le travail sera terminé lorsque cette cartographie de départ sera disponible pour planifier la restructuration et la réécriture.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100