Esta é a temporada de Documentos!
Promoção da colaboração em código aberto com redatores técnicos
Fase atual:
a temporada de documentos de 2019 foi concluída em 6 de março de 2020. Consulte a
linha do tempo.
O objetivo da Season of Docs é fornecer uma estrutura para que escritores técnicos e projetos de código aberto trabalhem juntos para o objetivo comum de melhorar a documentação de um projeto de código aberto. Para escritores técnicos que são novos no código aberto, o programa oferece uma oportunidade de ganhar experiência contribuindo com projetos de código aberto. Para escritores técnicos que já trabalham com código aberto, o programa oferece uma maneira potencialmente nova de trabalhar em conjunto. A temporada de documentos também oferece aos projetos de código aberto uma oportunidade de envolver mais a comunidade técnica de redação.
Durante o programa, os redatores técnicos passam alguns meses trabalhando em estreita colaboração com uma comunidade de código aberto. Eles trazem a experiência técnica de escrita para a documentação do projeto e, ao mesmo tempo, aprendem sobre o projeto de código aberto e novas tecnologias.
Os projetos de código aberto trabalham com os redatores técnicos para melhorar a documentação e os processos do projeto. Juntos, eles podem escolher criar um novo conjunto de documentação ou reformular os documentos existentes ou melhorar e documentar os procedimentos de contribuição e a experiência de integração da comunidade de código aberto.
Juntos, nós promovemos a conscientização pública sobre documentos de código aberto, sobre redação técnica e sobre como podemos trabalhar juntos em benefício da comunidade global de código aberto.
Como funciona?
Veja o fluxo de trabalho de alto nível do programa Temporada de Documentos:
Organizações de código aberto se inscrevem para ser organizações mentoras na temporada dos Documentos Google deste ano. Eles podem enviar uma lista de ideias de projetos de documentação com as inscrições.
Os redatores técnicos exploram a lista de organizações participantes e escolhem os projetos que interessam a elas. Um redator técnico pode entrar em contato com as organizações relevantes para discutir ideias. O redator técnico então escreve uma proposta de projeto e a envia para a Season of Docs.
As organizações confirmam os projetos de escrita técnica que querem orientar.
Os redatores técnicos aceitos passam alguns meses trabalhando com mentores das organizações de código aberto para concluir seus projetos.
No final do programa, os administradores do Google anunciam os projetos que foram concluídos com sucesso.
O cronograma mostra os detalhes das etapas envolvidas e as principais datas.
Participantes e funções
Confira abaixo os principais grupos de pessoas que participam da temporada de documentos e o papel de cada grupo no programa:
Os administradores da organização são membros das organizações de código aberto participantes que agem como o principal contato da temporada de documentos da organização. Os administradores da organização enviam a inscrição para participar da temporada de Documentos, gerenciar os mentores das organizações, verificar se os projetos técnicos de redação estão no caminho certo, lidar com a papelada e gerenciar a distribuição do salário do mentor. Consulte o guia e as responsabilidades do administrador
Os Mentores de código aberto são membros das organizações de código aberto participantes que foram aceitas como mentores na temporada de Documentos Google deste ano. Os mentores trabalham em estreita colaboração com os redatores técnicos para ajudar a garantir um projeto bem-sucedido. Consulte o guia e as responsabilidades do mentor.
Os escritores técnicos são redatores técnicos do mundo todo que estão aceitos para participar da temporada de Documentos deste ano. Os candidatos precisam demonstrar experiência prévia em redação técnica enviando descrições de cargos e amostras de trabalho. Consulte o guia e as responsabilidades do redator técnico.
Os administradores de programa do Google são gerentes de programa dentro do Google que executam o programa Temporada dos Documentos.
Próximas etapas
- Participe da lista de e-mails de avisos em season-of-docs-announce para ficar por dentro de quando as inscrições são abertas e outros eventos importantes do programa.
- Confira a linha do tempo para ver datas e marcos importantes.
- Comece registrando-se como participante, seja você um redator técnico ou um membro de um projeto de código aberto.
- Leia as perguntas frequentes se tiver alguma dúvida.
- Entre em contato se precisar de mais ajuda ou quiser participar das discussões.