Fase atual:
a temporada de documentos de 2019 foi concluída em 6 de março de 2020. Consulte a
linha do tempo.
Esta página contém diretrizes para organizações de código aberto sobre como avaliar propostas de projetos de redação técnica e selecionar os projetos que querem orientar na temporada de Documentos.
Introdução
Os redatores técnicos enviam propostas para a temporada de documentos para trabalhar em um projeto com a organização de código aberto selecionada. Os administradores do programa do Google encaminham as propostas às organizações de código aberto para avaliação e seleção de projetos. Para mais detalhes sobre as etapas envolvidas, consulte o guia do administrador da organização.
Avaliação de propostas de redatores técnicos
Experiência e habilidades técnicas de escrita
Examinar a experiência anterior do redator técnico. A proposta do redator técnico inclui informações sobre a experiência mais recente dele. O ideal é que o candidato tenha alguma experiência anterior na escrita de documentação técnica para o setor de software. Uma das metas da temporada de documentos é oferecer aos escritores técnicos a oportunidade de se envolver com produtos voltados para desenvolvedores. Por esse motivo, não é essencial que o escritor tenha experiência com APIs ou SDKs ou outras plataformas de desenvolvedor, mesmo que seu projeto se concentre em um público-alvo de desenvolvedores.
Concentre-se nas habilidades de linguagem e comunicação. Avalie a proposta do redator técnico deste ponto de vista. Mais importante: você consegue entender o que a pessoa escreveu? Como mentor, seu papel será ajudar o escritor técnico com os processos, ferramentas e códigos de código aberto. Você também não precisa revisar o texto da documentação resultante. Se você quiser fazer uma revisão detalhada da linguagem da proposta, verifique se a pontuação e as frases estão consistentes, com ortografia correta e linguagem clara. A frase é simples ou complicada? As frases são curtas ou continuam até se tornarem difíceis de seguir?
Preste atenção ao design e ao layout dos documentos. Como parte da proposta, o redator técnico tem a oportunidade de fornecer exemplos de documentação que desenvolveu. Verifique o layout geral das amostras de documentos. O design é lógico? Você consegue encontrar facilmente o documento ou conjunto de documentação? Há duplicação de conteúdo ou lacunas óbvias?
A proposta
Verifique se a proposta atende aos seus requisitos. A proposta está relacionada a alguma das ideias de projeto que você enviou para a temporada de Documentos Google deste ano? Se o redator técnico propôs uma nova ideia, verifique se ela atende às necessidades do projeto de código aberto e se você tem as pessoas certas para ajudar o redator técnico a atingir as metas do projeto proposto.
Procure entusiasmo e perfeição. A proposta demonstra que o redator técnico está animado com o projeto? Considere se eles pensaram e trabalharam na proposta, seja consultando sua organização durante a fase de exploração, ou adicionando suas próprias ideias sobre como atingir as metas do projeto.
Perguntas frequentes
Como decidimos quantos projetos enviar?
Concentre-se em um ou dois projetos. Se sua organização tiver capacidade para mencionar mais do que isso, envie mais. Para cada projeto de redator técnico, você precisa de pelo menos um mentor (de preferência dois) que se comprometa a orientar apenas esse projeto.
Leia as informações sobre como funciona a alocação de slots na temporada de documentos.
Como escolhemos qual proposta de redação técnica aceitar?
Certifique-se de selecionar as melhores propostas de redator técnico que você recebeu. Ou seja, selecione as propostas que melhor se adaptam aos seus requisitos e que melhor se encaixam nas diretrizes de avaliação listadas acima.
Onde estão os formulários necessários para enviar as propostas selecionadas?
Consulte o guia para administradores da organização.