python / python/docs-community
Diátaxis: Where are we?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Makefile
- Estrellas
- 55
- Forks
- 26
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza revisando el modelo Diátaxis enlazado en el issue y la estructura actual de la documentación de Python. Haz un inventario de las secciones individuales de la documentación y registra dónde encaja cada una en el gráfico de Diátaxis; el trabajo estará terminado cuando ese mapa inicial esté disponible para planificar la reestructuración y la reescritura.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100