Fase atual:
Resultados anunciados
da linha do tempo.
Aqui estão algumas diretrizes para ajudar as organizações de código aberto a trabalhar de maneira eficaz com redatores técnicos.
Apresentar o escritor técnico ao mundo do código aberto e à sua comunidade
- Ofereça ao escritor técnico um "tour guiado" pela sua comunidade. Onde é possível fazer perguntas? De quais reuniões regulares ele deve participar, ou de quais listas de e-mails eles devem participar? De que contas eles precisam (GitHub, Discord, Slack)? Certifique-se de que eles entendam o código de conduta do seu projeto e saibam como relatar quaisquer problemas. Verifique se o redator técnico entende a licença do projeto e cumpre todos os requisitos de outros empregadores em relação à assinatura de CLAs, DCOs ou outros contratos.
- Se possível, apresente-os a algumas pessoas em fusos horários conflitantes que podem responder rapidamente a perguntas sobre a comunidade ou o projeto.
- Se possível, envie alguns brindes do projeto.
Ajudar o redator técnico a usar as ferramentas e os processos envolvidos para contribuir com o projeto
- Se os processos não estiverem bem documentados, marque um horário para explicar ao redator técnico a primeira contribuição, problema ou solicitação de envio. Quais modelos ou tags ele deve usar? Quem precisa revisar a contribuição e como e quando deve fazer o acompanhamento das avaliações? Se o trabalho inclui exemplos de código, como eles podem ser testados? O que eles precisam saber sobre seu processo ou versões de CI/CD?
Ajudar o redator técnico a entender seu projeto e os usuários dele
- Explique seu projeto em detalhes para que o redator técnico tenha uma firme compreensão conceitual do produto. Isso pode ajudar o escritor técnico a se sentir mais confiante e ter mais autoridade ao escrever para o projeto.
- Descreva as necessidades das pessoas que usam o projeto. Seja o mais específico possível. Não apenas "desenvolvedores", mas "desenvolvedores que criam sites" e "desenvolvedores que programam robôs industriais".
- 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 projeto que a documentação abordará.
- Garantir que o redator técnico tenha o tempo e os recursos necessários dos especialistas no assunto e de quaisquer outros membros da comunidade.
Faça perguntas.
- Sua comunidade ou projeto pode não ter trabalhado com redatores técnicos ou colaboradores de documentação antes. Aproveite a oportunidade de aprender enquanto compartilha o que você sabe! Peça feedback sobre seus processos e ferramentas. Seu redator técnico provavelmente terá algumas sugestões de melhoria.