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

Fase atual:
desenvolvimento da documentação. Consulte o cronograma.

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. Isso não se destina a uma orientação jurídica ou uma lista completa de todos os pontos possíveis a serem considerados ao criar contratos de escrita técnica para projetos de código aberto. Dependendo das necessidades da organização ou do projeto, consulte sua assessoria jurídica antes de contratar um redator técnico.

Escopo do trabalho

  • Crie uma lista dos trabalhos cobertos pelo 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 exemplo de comando curl ou uma lista de parâmetros.
  • Como saber se um conteúdo está "concluído"?
  • Outros pontos a serem considerados:
    • Quem terá os direitos autorais da obra? Com qual licença ela será lançada (são diferentes)? Que crédito o redator técnico receberá (mencionar no site, listado como colaborador etc.)? E se o conteúdo precisar ser licenciado outra vez no futuro? Por exemplo, se você espera que o redator técnico assine o contrato de licença de colaborador do projeto de código aberto, informe isso.
    • Se você espera que o redator técnico participe de várias aprovações de revisão, especifique-as. Por exemplo, é possível declarar que espera um primeiro rascunho, depois uma segunda passagem para resolver problemas técnicos e uma última para revisão.
    • Se você espera que o redator técnico forneça conteúdo em um formato específico, como Markdown, inclua isso em seu contrato.
    • Seu projeto tem diretrizes para o uso da IA generativa para criar documentação ou código? Certifique-se de que essas diretrizes foram compartilhadas com seu redator técnico.

Remuneração

  • Combine com o redator técnico um calendário de pagamentos vinculado a datas e entregas firmes.
  • Você vai pagar uma quantia antecipada 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 morte" para ajudar a compensar o tempo gasto pelo redator técnico?
  • Quem será responsável por quaisquer taxas de conversão de moeda relacionadas à forma de pagamento escolhida?

Comunicação

  • Você espera que o redator técnico esteja disponível para videochamadas ou reuniões?
  • Quais canais de comunicação você 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 do projeto pode entrar em contato para perguntas diferentes, como problemas de pagamento, necessidade de revisão, desbloqueio de problemas com 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, conseguir acesso ou receber permissões?

Resolver discordâncias

  • Como você resolverá as divergências 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, considere especificar as próximas etapas ("Esperamos que uma solicitação de envio do 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 precisa desistir, como ele deve comunicar isso? Se possível, ele deve avisar o usuário, criar um documento de transferência ou fazer uma chamada de transferência?
  • Não se esqueça de considerar as obrigações do projeto com 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 redator pelo tempo.
  • Declare explicitamente que o redator técnico está sujeito ao Código de Conduta do projeto e ao seu processo de aplicação desse Código. Você pode deixar explícito que as violações de CoC resultarão na rescisão do projeto e na perda do pagamento de qualquer trabalho pendente.