Fase atual:
Resultados anunciados
da 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.
Introdução
As organizações de código aberto precisam contratar um redator técnico para trabalhar no projeto proposto. As organizações devem ter o próprio redator técnico. Os escritores técnicos interessados em trabalhar com organizações que participam da temporada de documentos podem ser encontrados no repositório da temporada de documentos do GitHub e no canal#season-of-docs (links em inglês) na seção "Escreva os documentos" do Slack.
Como iniciar o processo
Recomendamos que você inicie o processo de encontrar um redator técnico assim que achar que pode querer participar da temporada de Documentos.
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 se concentrar na avaliação das habilidades e experiências técnicas de escrita.
Experiência e habilidades técnicas de escrita
Examinar a experiência anterior do redator técnico. O ideal é que o redator técnico tenha alguma experiência prévia na escrita de documentação técnica para o setor de software. Uma das metas da temporada de documentos é permitir que os escritores técnicos se envolvam 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 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 deste 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 escritor técnico, procure consistência na pontuação e frase, ortografia correta e linguagem clara. A frase é simples ou complicada? As frases são curtas ou continuam até que se tornem difíceis de seguir?
Preste atenção ao design e ao layout dos documentos. 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?
Contratar um redator técnico
As organizações precisam contratar um redator técnico e preencher o formulário de contratação de comprovação de redator técnico vinculado abaixo até 16 de maio de 2022, às 18h UTC.
A fase de contratação do redator técnico foi concluída.
Discuta a compensação e um calendário de pagamentos 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 nos marcos do projeto, incluindo um pagamento no início do projeto. Lembre-se das datas de pagamento, que só acontecerão duas vezes ao longo do programa, e dos valores ao criar um calendário de pagamentos.
Observação: as organizações que não contrataram um redator técnico e enviaram o formulário de contratação de comprovante de redator até 16 de maio de 2022, às 18h (UTC), não vão receber fundos na primeira data de pagamento.