Trabalhar com um redator técnico

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

Aqui estão algumas diretrizes para organizações de código aberto sobre como trabalhar com um redator técnico que você está orientando para a Season of Docs:

  • Apresente o redator técnico ao mundo do código aberto e à sua comunidade.
  • Ajudar o redator técnico a usar as ferramentas e os processos envolvidos na contribuição ao projeto.
  • Explique seu produto em detalhes para que o redator técnico tenha uma compreensão conceitual firme do produto. Isso pode ajudar o redator técnico a se sentir mais confiante e ter mais autoridade ao escrever para o projeto.
  • Descreva as necessidades do seu público, ou seja, as necessidades dos desenvolvedores que usam seu produto e/ou outros grupos que usam o produto.
  • Conhecer os casos de uso importantes com o redator técnico para ajudar a projetar a documentação necessária.
  • Analise o código quando o redator técnico precisar entendê-lo antes de escrever os documentos.
  • colocar o redator técnico em contato com os especialistas necessários no assunto. Ou seja, os desenvolvedores ou outros colaboradores do projeto responsáveis pelos aspectos do produto que a documentação abordará.
  • Garantir que o redator técnico consiga o tempo e os recursos necessários dos especialistas no assunto e de outros membros da comunidade.
  • Trabalhe com o redator técnico para adicionar amostras de código significativas aos documentos, quando relevante.

Alguns lembretes

Os mentores de código aberto da temporada de Documentos não são necessariamente redatores técnicos. Os mentores não precisam ter habilidades de documentação. Os redatores técnicos aplicam essas habilidades ao projeto e à relação de orientação.

Em vez disso, eles trazem o conhecimento sobre a comunidade de código aberto, o produto, os processos e as ferramentas que o projeto de código aberto usa.

Um resultado importante do relacionamento de mentoria deve ser que o redator técnico tenha uma experiência gratificante e bem-sucedida na temporada deste ano dos Documentos Google. Uma experiência feliz aumenta as chances de o redator técnico continuar contribuindo com o projeto de código aberto após o encerramento da temporada de documentos deste ano e de que outros escritores técnicos se sintam entusiasmados por trabalhar com código aberto.