Guia do mentor

Fase atual:
a temporada de documentos de 2020 terminou em 15 de março de 2021. Consulte a linha do tempo.

Este é um guia para Mentores de código aberto, membros de organizações de código aberto que participam da Temporada de Documentos como mentores para redatores técnicos.

Introdução

Este guia ajuda você a realizar as tarefas que são sua responsabilidade em cada fase da temporada dos Documentos Google.

Uma das suas metas como mentor é garantir que os redatores técnicos tenham uma experiência gratificante e de sucesso na temporada de Documentos deste ano. Isso aumentará as chances de os redatores técnicos continuarem contribuindo para seu projeto de código aberto após o encerramento da temporada de documentos deste ano, e de que outros redatores técnicos ficarão entusiasmados em trabalhar com código aberto.

Fase de inscrição da organização

A fase de inscrição da organização vai de 13 de abril de 2020 a 4 de maio de 2020. Durante esse período, o administrador da organização pode enviar uma inscrição para que ela participe da temporada de documentos. Os administradores do programa do Google publicam a lista de organizações bem-sucedidas em 11 de maio de 2020.

Suas tarefas como mentor nesta fase

Crie sua lista de ideias.

Trabalhe com o administrador da sua organização para criar uma lista de ideias de projeto. A lista deve incluir um ou mais projetos de documentação que você gostaria que um redator técnico abordasse durante a temporada de Documentos deste ano.

Ideias para projetos de escrita técnica

Inscreva-se na temporada de Documentos.

Inscreva-se para a temporada de documentos o quanto antes.

As inscrições para a temporada de documentos de 2020 foram encerradas.

Fale sobre a temporada de documentos.

Conte que sua organização está participando da temporada de Documentos. Mesmo que sua organização não esteja na lista final de organizações aceitas este ano, ainda é ótimo saber que você fez parte do processo de seleção.

Material promocional

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, os redatores técnicos exploram a lista de organizações participantes e as ideias de projetos das organizações. Os redatores técnicos podem abordar uma ou mais organizações diretamente para discutir ideias de projetos.

Suas tarefas como mentor nesta fase

Discutir ideias para o projeto com redatores técnicos interessados.

É possível discutir ideias de projeto com qualquer redator técnico que aborde sua organização diretamente, para ajudá-lo a montar uma boa proposta de projeto a ser enviada aos administradores do programa do Google. As ideias do projeto podem vir da lista de ideias que sua organização propôs, bem como de outras ideias que o redator técnico propõe.

Ideias para projetos de escrita técnica

Avaliação das propostas de redatores técnicos

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, os redatores técnicos se inscrevem para participar da temporada de Documentos, e as organizações selecionam os projetos que querem orientar.

Suas tarefas como mentor nesta fase

Avaliar propostas de redatores técnicos.

Trabalhe com o administrador da sua organização para avaliar as propostas dos redatores técnicos e selecionar os projetos técnicos de redação que sua organização quer orientar durante a temporada de Documentos Google deste ano.

Avaliação das propostas de redatores técnicos

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 ajudam os redatores técnicos aceitos a se familiarizar com o projeto de código aberto.

Suas tarefas como mentor nesta fase

Apresentar o redator técnico ao projeto e à comunidade de código aberto.

Apresente o redator técnico à organização de código aberto e ajude-o a se familiarizar com as ferramentas e os processos que você usa.

Como trabalhar com um redator técnico

Suas responsabilidades

Explique seu produto ao redator técnico.

Passe um tempo explicando o produto (especialmente conceitualmente) e garantindo que o redator técnico entenda o público da documentação.

Como trabalhar com um redator técnico

Configurar os canais de comunicação.

Incentive o redator técnico a se apresentar nas listas de e-mails da comunidade, no chat, no canal do Slack e em qualquer outro canal de comunicação compartilhado. Certifique-se de que o redator técnico tem uma maneira confiável de se comunicar diretamente com você.

Suas responsabilidades

Defina metas e expectativas.

Trabalhar com o redator técnico para refinar as metas do projeto de redação técnica e definir as expectativas de ambos os lados. A meta é garantir o sucesso do projeto.

Suas responsabilidades

Fase de desenvolvimento do documento

A fase de desenvolvimento do documento vai de 14 de setembro de 2020 a 30 de novembro de 2020. Durante esse período, os redatores técnicos trabalham nos projetos em consulta com seus mentores.

Suas tarefas como mentor nesta fase

Aconselhe e incentive o redator técnico.

Trabalhar em estreita colaboração com o redator técnico para garantir a conclusão bem-sucedida do projeto.

Como trabalhar com um redator técnico

Suas responsabilidades

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 fases de avaliação

A fase de finalização do projeto vai de 3 a 10 de dezembro de 2020. As datas são diferentes para projetos de longa duração. Durante esse período, os redatores técnicos enviam os produtos de trabalho finais e as avaliações de mentores.

A fase de avaliação do mentor vai de 3 de dezembro de 2020 a 10 de dezembro de 2020 às 18h UTC. Durante esse período, os mentores enviam avaliações do sucesso dos projetos de redação técnica e a experiência deles trabalhando com os redatores técnicos.

Suas tarefas como mentor nesta fase

Escrever e enviar sua avaliação do projeto de redação técnica.

Conclua e envie suas avaliações até 12 de março de 2021, às 18h (UTC).

Como avaliar um projeto de escrita técnica

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. Durante esse período, os redatores técnicos enviam os produtos e avaliações de trabalho finais, e os mentores enviam suas avaliações.

Suas tarefas como mentor para um projeto de longa duração

Aconselhar o redator técnico e enviar sua avaliação do projeto.

Suas tarefas e responsabilidades são as mesmas descritas nesta página para projetos de redação técnica de tamanho padrão, exceto que as datas para finalização e avaliações do projeto são posteriores.