Fase atual:
Estudos de caso publicados. Consulte
linha do tempo.
Esta página contém dicas para organizações de código aberto sobre como avaliar e selecionar o redator técnico certo para a proposta de projeto da Temporada de documentos do Google.
Introdução
As organizações de código aberto precisam contratar um redator técnico para trabalhar no projeto proposto. As organizações precisam ter um redator técnico. Redatores técnicos interessados em trabalhar com organizações participantes da Google Season of Docs podem ser encontrados no repositório do GitHub da Google Season of Docs e no canal#season-of-docs no Slack do Write the Docs.
Como iniciar o processo
Recomendamos que você comece a procurar um redator técnico assim que achar que quer participar da Temporada de documentos do Google.
Como avaliar um redator técnico
É recomendável solicitar exemplos de documentação desenvolvida anteriormente dos redatores técnicos que você está considerando para avaliar as habilidades e a experiência deles.
Habilidades e experiência em redação técnica
Examinar a experiência anterior do redator técnico. O ideal é que o redator técnico tenha alguma experiência anterior na elaboração de documentação técnica para o setor de software. Uma das metas da temporada de documentos do Google é dar aos redatores técnicos a oportunidade de se envolver com produtos voltados para desenvolvedores. Por isso, não é essencial que o escritor tenha experiência com APIs, SDKs ou outras plataformas para desenvolvedores, mesmo que seu projeto se concentre em um público de desenvolvedores.
Concentre-se nas habilidades de linguagem e comunicação. Avalie o trabalho anterior do redator técnico sob esse ponto de vista. O mais importante: você consegue entender o que a pessoa escreveu? Se você quiser fazer uma revisão detalhada da linguagem do trabalho do redator técnico, procure consistência na pontuação e na fraseologia, ortografia correta e linguagem clara. A frase é simples ou complicada? As frases são curtas ou se estendem até ficarem difíceis de seguir?
Preste atenção ao design e ao layout do documento. Confira o layout geral dos documentos de amostra. O design é lógico? Você consegue navegar facilmente pelo documento ou pelo conjunto de documentação? Há duplicidade de conteúdo ou lacunas óbvias?
Contratar um redator técnico
As organizações precisam contratar um redator técnico e preencher o formulário de contratação de redator técnico abaixo até 22 de maio de 2024 às 18h00 UTC.
Fase de contratação de redatores técnicos concluída.
Discuta a compensação e um cronograma de pagamento com o redator técnico antes da contratação. Recomendamos que as organizações criem um cronograma de pagamento com redatores técnicos com base em marcos do projeto, incluindo um pagamento no início do projeto. Considere as datas de pagamento, que só vão acontecer duas vezes durante o programa, e os valores ao criar um cronograma de pagamentos.
Observação: as organizações que não contrataram um redator técnico e enviaram o formulário de comprovação de contratação de redator técnico até 22 de maio de 2024, às 18h (UTC), não vão receber os fundos na primeira data de pagamento.