Como criar um contrato de redação técnica

Fase atual:
Estudos de caso publicados. Consulte linha do tempo.

Esta página contém algumas perguntas a serem consideradas ao criar um contrato com um redator técnico para a Temporada de documentos do Google. Este documento não é um conselho jurídico nem uma lista exaustiva de todos os pontos possíveis a serem considerados ao criar contratos técnicos por escrito para projetos de código aberto. Dependendo das necessidades da sua organização ou do projeto, consulte sua assessoria jurídica antes de contratar um redator técnico.

Escopo do trabalho

  • Crie uma lista do trabalho coberto pelo seu contrato. Seja o mais específico possível. Por exemplo, em vez de "Documentação da API", faça uma lista de quais endpoints precisam ser documentados e quais informações precisam ser incluídas, como um comando curl de exemplo ou uma lista de parâmetros.
  • Como você vai saber se um conteúdo está "finalizado"?
  • Outras considerações:
    • Quem vai ter os direitos autorais da obra? Em qual licença ele será lançado? (elas são diferentes!) Qual crédito o redator técnico vai receber (menção no site, listado como colaborador etc.)? E se o conteúdo precisar ser licenciado novamente no futuro? Por exemplo, se você espera que o redator técnico assine o Contrato de Licença do Colaborador do seu projeto de código aberto, comunique isso.
    • Se você espera que o redator técnico participe de várias revisões, especifique isso. Por exemplo, você pode declarar que espera um primeiro rascunho, depois uma segunda passagem para resolver problemas técnicos e, por fim, uma revisão final.
    • Se você espera que o redator técnico entregue conteúdo em um formato específico, como Markdown, inclua isso no seu contrato.
    • Seu projeto tem diretrizes para o uso de IA generativa para criar documentação ou código? Compartilhe essas diretrizes com o redator técnico.

Remuneração

  • Concordar com o redator técnico sobre um cronograma de pagamento vinculado a datas e entregáveis firmes.
  • Você vai pagar um valor inicial no início do trabalho?
  • O que acontece se o trabalho não puder ser usado ou aceito (porque as prioridades do projeto mudaram ou porque um revisor desistiu etc.)? Você pode pagar uma "taxa de cancelamento" para compensar o tempo gasto pelo redator técnico?
  • Quem será responsável pelas taxas de conversão de moeda relacionadas ao método de pagamento escolhido?

Comunicação

  • Você espera que o redator técnico esteja disponível para videochamadas ou reuniões?
  • Quais canais de comunicação você vai usar e quais são os tempos de resposta esperados? Por exemplo, se você espera que um redator técnico responda a e-mails (ou mensagens no Slack) em um dia, deixe isso explícito.
  • Com quem o redator técnico pode entrar em contato para tirar dúvidas, como problemas de pagamento, necessidade de revisão, problemas de desbloqueio de ferramentas ou canais ou outros bloqueadores?
  • Há um processo específico que o escritor precisa usar para enviar o trabalho ou receber feedback ou avaliações?

Ferramentas

  • Quais ferramentas (ou versões de ferramentas) o redator técnico precisa usar para criar o trabalho?
  • Quem é responsável por ajudar o redator técnico a configurar, acessar ou receber permissões?

Resolver discordâncias

  • Como você vai resolver os desacordos sobre a qualidade do trabalho do redator técnico? Quem tem a palavra final?
  • Qual seria o processo para liberar o redator técnico do projeto? Por exemplo, perder três prazos seguidos ou entregar um trabalho de qualidade inaceitável. Ao aplicar o processo, indique explicitamente as próximas etapas (por exemplo, "Esperamos que uma solicitação de pull para o primeiro rascunho seja enviada até a próxima sexta-feira" em vez de "Envie seu trabalho o mais rápido possível").
  • Se um redator técnico precisar desistir, como ele deve comunicar isso? Se possível, eles precisam dar aviso, criar um documento de transferência ou ter uma chamada de transferência?
  • Não se esqueça de considerar as obrigações do projeto para o redator técnico. Por exemplo, se os mentores do projeto desistirem e não puderem ser substituídos ou se as revisões prometidas não puderem ser concluídas, considere pagar uma parte dos fundos restantes ao redator técnico, mesmo que o projeto não possa ser concluído, para compensar o tempo dele.
  • Esclareça explicitamente que o redator técnico está vinculado ao Código de Conduta do projeto e inclua um link para o processo de aplicação do Código de Conduta. Talvez você queira explicitar que as violações do CoC resultarão no encerramento do projeto e na perda do pagamento por qualquer trabalho pendente.