Fase atual:
desenvolvimento da documentação. Consulte o
cronograma.
Aqui estão algumas diretrizes para ajudar as organizações de código aberto a trabalhar de maneira eficaz com os redatores técnicos.
Apresentar o redator técnico ao mundo do código aberto e à sua comunidade
- Dê ao escritor técnico um "tour guiado" pela sua comunidade. Onde ele pode fazer perguntas? De quais reuniões regulares eles devem participar ou de quais listas de e-mails eles devem participar? De que contas eles precisam (GitHub, Discord, Slack)? Certifique-se de que eles entendem o código de conduta do seu projeto e sabem como relatar quaisquer problemas. Verifique se o redator técnico entende a licença do seu projeto e está em conformidade com 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 na contribuição de seu projeto
- Se os processos não estiverem bem documentados, reserve um horário para explicar ao redator técnico a primeira contribuição, problema ou solicitação de envio. Quais modelos ou tags eles devem usar? Quem precisa revisar a contribuição e como e quando deve acompanhar as avaliações? Se o trabalho inclui amostras 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 seus usuários
- Explique seu projeto em detalhes para que o redator técnico tenha uma firme compreensão conceitual do produto. Isso pode ajudar o redator técnico a se sentir mais confiante e a 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 no assunto necessários. Ou seja, os desenvolvedores ou outros colaboradores responsáveis pelos aspectos do projeto que serão abordados na documentação.
- Garantir que o redator técnico consiga o tempo e os recursos necessários dos especialistas no assunto e de outros membros da comunidade.
Faça perguntas.
- Talvez sua comunidade ou seu projeto não tenha trabalhado com escritores 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. O redator técnico provavelmente terá algumas sugestões de melhoria.