python / python/docs-community
Diátaxis: Where are we?
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Makefile
- Estrelas
- 55
- Forks
- 26
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
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.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando o modelo Diátaxis vinculado na issue e a estrutura atual da documentação do Python. Faça um inventário das seções individuais da documentação e registre onde cada uma se enquadra no gráfico Diátaxis; o trabalho estará concluído quando esse mapa inicial estiver disponível para planejar a reestruturação e a reescrita.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100