Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Django
- Redator técnico:
- Gabbyprecies
- Nome do projeto:
- Reescrever o guia de contribuição para facilitar a navegação
- Duração do projeto:
- Duração padrão (3 meses)
Project description
ABSTRATA
O objetivo do guia de contribuição do Django, como qualquer outra documentação, é orientar usuários e colaboradores de código aberto nesse caso sobre como e onde eles podem contribuir para tornar o Django melhor e sustentável.
Há sempre a necessidade de fazer documentações especialmente aquelas que afetem 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, acessível e acolhedor para os colaboradores. Essa é uma meta essencial, porque incentiva colaboradores, aos quais eu mesmo pertenço para começar a contribuir com essa ótima estrutura.
Estado atual
O estágio atual da documentação, que pode ser encontrado aqui, não é realmente um guia, pois é muito pesado e não é bem estruturado e leva a menos entendimento de 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á a resolver o grande problema com a documentação atual. Estes são os objetivos que pretendo 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 Solicitações e criação de recursos Documentação reduzida e direta Glossário para 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 (seção "Guias para iniciantes e colaboradores" e manter o estilo dos colaboradores novos para seguir os princípios técnicos e de colaboradores novos para seguir os princípios.
A documentação atual já é destinada a colaboradores avançados e não oferece oportunidade a colaboradores iniciantes e iniciantes no código aberto e no Django. Aqui estão alguns conteúdos adicionais para iniciantes: Seção que orienta o conjunto diferente de colaboradores(escritores técnicos, designers e desenvolvedores) Uma página que documenta problemas do primeiro tempo e problemas fáceis que podem ser resolvidos. Reescreva algumas seções da documentação atual e adicione à seção para iniciantes. Seções que explicam os principais pontos ou palavras usadas nas seções avançadas.
Cronograma
Aqui está um detalhamento de como eu quero trabalhar na meta do projeto, conforme listado acima, com a agenda fornecida pelo Google.
Semana de vínculo com a comunidade( 17 de agosto a 13 de setembro) Envolva-se mais com a comunidade Continue contribuindo com a documentação Receba mais sugestões dos colaboradores Mais estudos sobre a documentação atual e as ferramentas pretendidas Semana 1 a semana 4 Comece com a documentação de seção com base nos níveis Crie a seção para iniciantes da documentação Semana 4 a 6 Guia de seleção de colaboradores e doação
Ferramentas
Sphinx - ferramenta atual da documentação. Leia a documentação.
Por que este Projeto?
Eu acredito na base de documentação e artigos bem escritos para abranger todas as pessoas do mundo. Além disso, também adoro o Django e o código aberto como um todo. Eu queria contribuir para o Django como iniciante e acho que essa é uma maneira perfeita de contribuir com minha ferramenta favorita, além de me familiarizar com a base de código para oferecer mais contribuição como desenvolvedor(e escritor técnico). Será prazeroso e lindo trabalhar com uma organização que se alinha às minhas opiniões e tem sido uma ótima ferramenta para toda a minha carreira.
Por que sou a pessoa certa para este projeto?
Acredito que sou a pessoa certa com base nestas contas: Tenho contribuído com o Django escrevendo artigos para ajudar os iniciantes a entender mais o conceito do Django. Como desenvolvedor e ansioso para contribuir para o Django, entendo a necessidade de colegas desenvolvedores e como documentar isso bem para eles. Sou um jogador de equipe e vou trabalhar bem sob menos ou mais supervisão do meu mentor Carlton Gibson.