Fase atual:
a temporada de documentos de 2020 terminou em 15 de março de 2021. Consulte a
linha do tempo.
Esta página contém o guia para escritores técnicos que participam da temporada de documentos.
Introdução
Esta é a temporada de Documentos! Este guia explica um pouco sobre sua participação na temporada de documentos e ajuda nas atividades que você deve realizar em cada fase do programa.
Qualificação para participar da temporada de documentos
Para participar da temporada de documentos como redator técnico, você precisa:
- Ter pelo menos 18 anos no momento da inscrição.
- Saber demonstrar experiência prévia em escrita técnica enviando descrições de cargos e amostras de trabalhos.
- Qualificação para trabalhar no próprio país de residência durante a duração do programa.
- Residente de um país que não está embargado pelos Estados Unidos no momento. Consulte as Informações sobre os programas de sanções e os países do Tesouro dos EUA.
Veja todos os termos técnicos.
Seus mentores de código aberto
Os mentores da temporada de Documentos não são necessariamente redatores técnicos, e eles podem ter pouca experiência em comunicação técnica. Eles são membros da organização de código aberto que sabem o valor de uma boa documentação e têm experiência com ferramentas e processos de código aberto.
O relacionamento entre você e seus mentores é uma colaboração. Você traz sua experiência e suas habilidades em documentação para a organização de código aberto. Seus mentores contribuem com o conhecimento sobre código aberto e código. Juntos, vocês podem desenvolver documentação técnica e melhorar os processos do projeto de código aberto.
Anúncio do programa e fases de candidatura da organização
A data de anúncio da temporada de documentos é 23 de março de 2020. As organizações de código aberto interessadas podem se inscrever para participar da temporada de documentos entre 13 de abril de 2020 e 4 de maio de 2020. Os administradores do programa do Google publicam a lista de organizações bem-sucedidas em 11 de maio de 2020.
Durante o período entre o anúncio do programa e a publicação das organizações de código aberto participantes, fique de olho nas notícias. Você pode voltar a este site e também assistir a postagens de blog ou outras notícias na Web. Algumas organizações de código aberto podem compartilhar ideias mesmo durante a fase de aplicação da organização.
Também convidamos você a divulgar a temporada de documentos e o motivo do seu interesse no programa. Consulte o material promocional para ver gráficos e ideias.
Fase de exploração do escritor técnico
A fase de exploração do gravador técnico vai de 11 de maio a 8 de junho de 2020. Durante esse período, você pode explorar a lista de organizações participantes e suas ideias de projetos. Esta é uma chamada aberta para escritores técnicos. Você não precisa da aprovação da temporada de documentos para começar. No entanto, lembre-se dos requisitos de qualificação acima.
Ao encontrar um ou mais projetos do seu interesse, aborde diretamente a organização de código aberto relevante para discutir as ideias do projeto.
| Suas tarefas como redator técnico durante esta fase | |
|---|---|
|
Confira a lista de organizações de código aberto participantes e as ideias de projetos delas. |
Examine a lista para encontrar uma organização de código aberto com a qual você gostaria de trabalhar. Analise os projetos de redação técnica que as organizações propuseram e decida quais são ideais para você. Você pode se inscrever em mais de uma organização. Nesta fase da temporada de Documentos, é recomendável explorar mais de uma opção. O processo de seleção final aceita apenas um projeto por redator técnico. |
|
Discutir ideias de projetos com organizações de código aberto. |
Você pode discutir ideias de projetos com qualquer uma das organizações participantes. Para fazer contato, use o endereço de e-mail exibido na lista de organizações participantes. As primeiras discussões ajudam a elaborar uma boa proposta de projeto para envio aos administradores do programa do Google durante a fase de inscrição do redator técnico. As ideias iniciais do projeto podem vir da lista de ideias que a organização propôs. Também é possível propor suas próprias ideias. |
Fase de inscrição do redator técnico
A fase de inscrição para gravação técnica vai de 9 de junho de 2020 a 9 de julho de 2020. Durante esse período, você pode se inscrever para participar da temporada dos Documentos Google. Os administradores do programa do Google encaminham os detalhes relevantes da sua inscrição para a organização de código aberto escolhida. Os administradores e mentores da organização de código aberto selecionam os projetos que querem orientar.
| Suas tarefas como candidato a redator técnico nesta fase | |
|---|---|
|
Envie sua inscrição para participar da temporada de documentos. |
Envie sua inscrição para a temporada de documentos antes de 9 de julho de 2020. As inscrições para gravação técnica da temporada de Documentos Google de 2020 foram encerradas. Inscreva-se na lista de e-mails de anúncios em season-of-docs-announce para ficar por dentro de tudo. |
Fase de vínculo comunitário
A fase de vínculo com a comunidade vai de 17 de agosto a 13 de setembro de 2020. Durante esse período, os mentores de código aberto ajudam você a se familiarizar com o projeto e a comunidade de código aberto.
| Suas tarefas como redator técnico durante esta fase | |
|---|---|
|
Configurar os canais de comunicação. |
Entre em contato com seus mentor(s) na organização de código aberto com que você escolheu trabalhar. Verifique se você tem uma maneira confiável de se comunicar diretamente com seu mentor e com os administradores da organização. Esses são os membros da organização de código aberto que atuam como o principal contato na temporada dos Documentos da organização. |
|
Participar do projeto e da comunidade de código aberto. |
Faça perguntas ao mentor sobre as ferramentas e os processos que a organização de código aberto usa. Apresente-se nas listas de e-mails, no chat, no canal do Slack e em qualquer outro canal de comunicação compartilhado da comunidade de código aberto. |
|
Entender o produto como um todo. |
Peça para seu mentor explicar o produto, principalmente conceitualmente, que você vai documentar em breve. Discutir o público da documentação em detalhes. |
|
Defina metas e expectativas. |
Trabalhe com seu mentor para refinar os objetivos do projeto técnico de redação e definir as expectativas dos dois lados. Definir essas metas e expectativas agora é uma boa maneira de garantir o sucesso do seu projeto. |
Fase de desenvolvimento do documento
A fase de desenvolvimento do documento vai de 14 de setembro de 2020 a 30 de novembro de 2020. A data de término é diferente para projetos de longa duração. Durante esse período, você trabalha no projeto sob uma consulta estreita com seus mentores.
| Suas tarefas como redator técnico durante esta fase | |
|---|---|
|
Trabalhe com seu mentor para concluir o projeto. |
Trabalhe em estreita colaboração com seu mentor para concluir o projeto. Siga os procedimentos da comunidade de código aberto para solicitar revisões da documentação resultante e enviar as atualizações ao repositório de código aberto. Por exemplo, projetos de código aberto hospedados em arquivos de adição ou atualização do GitHub criando uma solicitação de envio (em inglês) para revisão e envio. |
|
Encaminhe qualquer dúvida ao administrador da organização. |
Se você tiver alguma dúvida sobre a comunicação com seus mentores ou se encontrar algum outro problema que possa afetar a conclusão do projeto, informe o administrador da organização de código aberto. |
|
Responda a qualquer pesquisa dos administradores do programa do Google. |
Os administradores do programa do Google podem enviar uma pesquisa durante o projeto para avaliar o progresso. Responda à pesquisa e envie suas respostas aos administradores do programa do Google, conforme as instruções no documento de pesquisa. |
Finalização do projeto e fase de avaliação
A fase de finalização do projeto vai de 30 de novembro a 5 de dezembro de 2020, e a fase de avaliação vai de 3 a 10 de dezembro de 2020. As datas são diferentes para projetos de longa duração. Durante o período de finalização do projeto, você envia o relatório dele, também chamado de produtos de trabalho finais. Durante a fase de avaliação, você envia uma avaliação do seu mentor e da sua experiência como participante da temporada de Documentos Google.
| Suas tarefas como redator técnico durante esta fase | |
|---|---|
|
Escreva o relatório do projeto. |
Escreva o relatório do projeto (às vezes chamado de produto de trabalho). O relatório do projeto inclui uma descrição do trabalho feito durante a temporada de Documentos e todos os links relevantes. Como criar o relatório do projeto A fase de finalização do projeto de longa duração foi encerrada. |
|
Peça ao seu mentor para revisar o relatório do projeto. |
Seu mentor pode ter insights valiosos sobre como descrever suas conquistas. Além disso, chegar a um entendimento compartilhado do estado do projeto é útil nesta fase, antes que seu mentor marque o projeto como concluído com sucesso ou não. |
|
Finalizar o relatório do projeto. |
Finalize o relatório do projeto até 8 de março de 2021, às 18h (UTC). O formulário é editável, mas você precisa enviar a versão final até a data indicada. A fase de finalização do projeto de longa duração foi encerrada. |
|
Escreva e envie uma avaliação sobre seu mentor e sua experiência com a temporada de Documentos Google. |
Conclua e envie sua avaliação até 12 de março de 2021, às 18h (UTC). Avaliações feitas por avaliadores técnicos A fase de avaliação do projeto de longa duração foi encerrada. |
Projetos de longa duração
Para projetos de escrita técnica de tamanho padrão na temporada de documentos, a fase de desenvolvimento do documento vai de 14 de setembro de 2020 a 30 de novembro de 2020. No entanto, alguns escritores técnicos podem se inscrever em um projeto de longa duração sob consulta com a organização de código aberto. Para um projeto de longa duração, a fase de desenvolvimento de documentos é realizada de 14 de setembro de 2020 a 1o de março de 2021.
O período de finalização e avaliação de projetos de longa duração é de 1o a 8 de março de 2021.
Suas tarefas e responsabilidades são as mesmas descritas nesta página para projetos de escrita técnica de tamanho padrão, exceto que as datas para finalização e avaliações do projeto são posteriores.
Informações relacionadas
- Consulte o cronograma da temporada de documentos.
- Saiba mais sobre seu relacionamento com a organização de código aberto escolhida lendo as responsabilidades de administrador e mentor da organização e as diretrizes do mentor sobre como trabalhar com um redator técnico.