Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- Django
- Redator técnico:
- Gabbyprecious (link em inglês)
- Nome do projeto:
- Reescrever o guia de contribuição para ser mais fácil de usar e navegar
- Duração do projeto:
- Duração padrão (três meses)
Project description
ABSTRATA
O objetivo do guia de contribuição do Django, assim como qualquer outra documentação, é orientar o usuário, colaboradores de código aberto, neste caso, sobre como e onde eles podem contribuir para tornar o Django melhor e sustentável.
Sempre há a necessidade de fazer documentações, especialmente aquelas que afetam muito a comunidade e o próprio Django.
O objetivo do Django para o Google Summer of Docs deste ano é tornar o guia de contribuição menos complexo, mais acessível e acolhedor para os colaboradores. Essa é uma meta essencial, porque incentiva os colaboradores, como eu, a começar a contribuir com esse ótimo framework.
Estado atual
O estágio atual da documentação, que pode ser encontrado aqui, não é realmente um guia, porque é muito complexo e não está bem estruturado, o que dificulta o entendimento da contribuição no Django e não é acolhedor para novos colaboradores.
Metas do projeto
Discuti minhas sugestões para a documentação com meu mentor, Carlton Gibson, no fórum e ele aprova que isso ajudará no problema esmagador da documentação atual. Estas são as metas que pretendo alcançar para reestruturar o documento: Reestruturar o documento Adicionar o que fazer e o que não fazer Criar páginas únicas para seções triviais, como solicitar e criar recursos Documentação reduzida e direta Glossário de palavras Índice interno criado para seguir o novo guia Escrever uma documentação mais fácil de se identificar Segmentar o conteúdo em duas partes principais (como criar o guia para iniciantes e os colaboradores avançados e manter os padrões atualizados) construir um guia técnico e criar um guia técnico.
A documentação atual já é destinada a colaboradores avançados e não dá a chance de colaboradores novos e iniciantes, tanto para código aberto quanto para Django, veja aqui alguns conteúdos adicionais para iniciantes: Seção que orienta diferentes conjuntos de colaboradores(escritores técnicos, designers e desenvolvedores) Uma página que documenta problemas de tempo inicial e problemas fáceis que podem ser resolvidos. Pegue algumas seções da documentação atual, reescreva e adicione à seção para iniciantes. Seções que expliquem os pontos-chave ou as palavras usadas na seção avançada.
Cronograma
Aqui vai um detalhamento de como quero trabalhar na meta do projeto, conforme listado acima, com a agenda fornecida pelo Google.
Ferramentas
Sphinx: ferramenta atual para a documentação atual. Leia a documentação.
Por que este projeto?
Acredito que a documentação e os artigos bem escritos são essenciais para abranger todos em todo o mundo. Além disso, também sou fã do Django e do código aberto em geral. Quero contribuir com o Django como iniciante e acho que essa é a maneira perfeita de contribuir com minha ferramenta favorita e, ao mesmo tempo, me familiarizar com a base de código para oferecer mais contribuição como desenvolvedor(e redator técnico). Será agradável e bonito trabalhar com uma organização que está alinhada com minhas opiniões e tem sido uma ótima ferramenta para toda a minha carreira.
Por que sou a pessoa certa para esse projeto?
Acredito que sou a pessoa certa com base nas seguintes contas: Tenho contribuído com o Django escrevendo artigos para ajudar os iniciantes a entender melhor o conceito do Django. Sendo um desenvolvedor e alguém ansioso para contribuir com o Django, entendo a necessidade de outros desenvolvedores e como documentá-la bem para eles. Sou um jogador de equipe e trabalho bem com mais ou menos supervisão do meu mentor, Carlton Gibson.