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:
- Chat da equipe de código aberto Zulip
- Redator técnico:
- drrosa (em inglês)
- Nome do projeto:
- Refatoração de ReadTheDocs e documentos da API
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Vou me concentrar em duas áreas e trabalhar nelas em paralelo. Uma delas é melhorar a qualidade de zulip.readthedocs.io para que os novos colaboradores tenham menos confusão e dúvidas. Idealmente, o resultado será um caminho claro e conciso de uma contribuição inicial para se familiarizar com a forma como Zulip funciona. Também pretendo trabalhar em zulipchat.com/api, api.md e openapi.md para facilitar a compreensão do processo de documentação de endpoints adicionais. É provável que as duas partes envolvam atualização/simplificação de conteúdo, organização de artigos, adição de documentação de desenvolvedor ausente e também escrita/teste de código.
O projeto terá quatro fases. A primeira fase vai incluir pequenos projetos de familiarização, ferramentas preparatórias e uma melhor compreensão das necessidades de documentação atuais. O objetivo da segunda fase será estruturar, especificar e priorizar o trabalho dentro do contexto das metas da Zulip neste outono. Em seguida, passarei para a fase de implementação do projeto. Vou entrar em contato com mentores e com o restante da comunidade de desenvolvedores do Zulip para pedir feedback. A fase final será examinar, revisar onde 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 os outros estão trabalhando, incluindo decisões tomadas pelos principais desenvolvedores. Espero que aprender a se adaptar bem a essas mudanças seja um aspecto necessário para ter uma experiência bem-sucedida com o GSoD. É possível que, em algum momento, faça sentido adiar as ideias propostas para mais tarde. De modo geral, vou me concentrar em garantir que meu trabalho agrega valor ao sucesso geral do projeto de código aberto Zulip.