Fase atual:
desenvolvimento da documentação. Consulte o
cronograma.
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 o próprio redator técnico. Os escritores técnicos interessados em trabalhar com organizações que participam da Temporada de Documentos Google podem ser encontrados no repositório da Temporada de Documentos Google do GitHub (em inglês) e no canal#season-of-docs no Slack do Write the Docs.
Como iniciar o processo
Recomendamos que você comece o processo de encontrar um redator técnico assim que achar que pode querer 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 que possa avaliar as habilidades e a experiência técnica de escrita.
Habilidades e experiência técnica de escrita
Examinar a experiência anterior do redator técnico. O ideal é que o redator técnico tenha alguma experiência prévia em escrever documentação técnica para o setor de software. Uma das metas da temporada de documentos do Google é dar aos escritores técnicos a oportunidade de se envolver com produtos focados em desenvolvedores. Por esse motivo, não é essencial que o criador tenha experiência com APIs, SDKs ou outras plataformas de 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 escritor técnico desse ponto de vista. Mais importante: você consegue entender o que a pessoa escreveu? Se você quiser fazer uma revisão aprofundada da linguagem do trabalho do redator técnico, procure consistência na pontuação e na frase, ortografia correta e linguagem clara. A frase é simples ou complicada? As frases são curtas ou são executadas até que se tornam difíceis de seguir?
Preste atenção ao design e layout dos documentos. Verifique o layout geral dos exemplos de documentos. O design é lógico? Você consegue encontrar facilmente o documento ou conjunto de documentação? Existe conteúdo duplicado ou lacunas óbvias?
Contratação de um redator técnico
As organizações precisam contratar um redator técnico e preencher o Formulário de contratação de escritor técnico vinculado abaixo até 22 de maio de 2024, às 18h (UTC).
Formulário de contratação de redator técnico
Não deixe de discutir a compensação e o calendário de pagamentos com o redator técnico antes da contratação. Recomendamos que as organizações criem um cronograma de pagamento com os redatores técnicos com base nos marcos do projeto, incluindo um pagamento no início do projeto. Tenha em mente as datas de pagamento, que só acontecerão duas vezes ao longo do programa, e os valores ao criar um calendário de pagamentos.
Observação: as organizações que não contrataram um redator de tecnologia e enviaram o formulário de contratação de comprovante de redação técnica até 22 de maio de 2024 às 18h (UTC) não vão receber fundos na primeira data de pagamento.