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:
- Zulip Open Source Team Chat
- Redator técnico:
- Drrosa
- Nome do projeto:
- Refactoring de ReadTheDocs e API Docs
- Duração do projeto:
- Duração padrão (três meses)
Project description
Vou me concentrar em duas áreas e trabalhar nelas em paralelo. Uma delas é melhorar a qualidade do zulip.readthedocs.io para que os novos colaboradores tenham menos dúvidas e confusão no caminho. O ideal é que o resultado seja um caminho claro e conciso, desde a primeira contribuição até a familiarização com o funcionamento do Zulip. Também pretendo trabalhar em zulipchat.com/api, api.md e openapi.md para facilitar a compreensão do processo de documentação de outros endpoints. É provável que as duas partes envolvam atualização/simplificação de conteúdo, organização de artigos, adição de documentação do desenvolvedor ausente e escrita/teste de código.
O projeto vai consistir em quatro fases. A primeira fase inclui pequenos projetos de familiarização, ferramentas preparatórias e um melhor entendimento das necessidades atuais de documentação. O objetivo da segunda fase será estruturar, especificar e priorizar o trabalho no contexto das metas da Zulip neste outono. Depois, vou passar para a fase de implementação do projeto. Vou trocar mensagens com mentores e com o restante da comunidade de desenvolvedores do Zulip para receber feedback. A fase final será olhar para trás, revisar onde for necessário e escrever o relatório do projeto.
Suspeito que algumas prioridades e tarefas provavelmente mudarão ao longo do período de trabalho como resultado do que todos estão trabalhando, incluindo decisões tomadas pelos desenvolvedores principais. Aprender a se adaptar a essas mudanças será um aspecto necessário para ter uma experiência de GSoD bem-sucedida. Talvez em algum momento faça sentido adiar as ideias propostas para mais tarde. De modo geral, vou me concentrar em garantir que meu trabalho traga valor para o sucesso geral do projeto de código aberto do Zulip.