Fase atual:
Finalização do projeto. Consulte
linha do tempo.
Confira algumas diretrizes para ajudar organizações de código aberto a trabalhar de forma eficaz com escritores técnicos.
Apresente o redator técnico ao mundo do código aberto e à sua comunidade
- Faça um "tour guiado" da sua comunidade para o escritor técnico. Onde eles podem fazer perguntas? Quais reuniões regulares eles precisam participar ou em quais listas de e-mail eles precisam se inscrever? Quais contas eles precisam (Github, Discord, Slack)? Confira se eles entendem o código de conduta do projeto e sabem como informar problemas. Confira se o redator técnico entende a licença do projeto e obedece a todos os requisitos de outros empregadores em relação à assinatura de CLAs, DCOs ou outros acordos.
- Se possível, apresente a eles algumas pessoas em fusos horários sobrepostos que possam responder rapidamente a perguntas sobre a comunidade ou o projeto.
- Se possível, envie alguns itens do projeto.
Ajude o redator técnico a usar as ferramentas e os processos envolvidos na contribuição para seu projeto
- Se seus processos não estiverem bem documentados, agende um horário para orientar o redator técnico na primeira contribuição, problema ou solicitação de pull. Quais modelos ou tags ela precisa usar? Quem precisa analisar a contribuição e como e quando ela precisa ser analisada? Se o trabalho inclui amostras de código, como elas podem ser testadas? O que ele precisa saber sobre seu processo de CI/CD ou versões?
Ajude o redator técnico a entender seu projeto e os usuários
- Explique seu projeto em detalhes para que o redator técnico entenda bem o conceito do produto. Isso pode ajudar o redator técnico a se sentir mais confiante e ter mais autoridade na escrita do 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".
- Coloque o redator técnico em contato com os especialistas necessários. Ou seja, os desenvolvedores ou outros colaboradores do projeto responsáveis pelos aspectos do projeto que serão abordados na documentação.
- Garanta que o redator técnico tenha o tempo e os recursos necessários dos especialistas em matéria e de outros membros da comunidade.
Faça perguntas.
- Talvez sua comunidade ou projeto não tenha trabalhado com redatores técnicos ou colaboradores de documentação antes. Aproveite a oportunidade para aprender enquanto compartilha o que sabe. Peça feedback sobre seus processos e ferramentas. O redator técnico provavelmente terá algumas sugestões de melhoria.