Documentação

Descubra

Pergunte ao cliente sobre seus objetivos, sistemas, regras e processos, e escreva as respostas em um documento de descoberta que será usado em todas as etapas posteriores.

Descubra o que o cliente precisa antes de alterar uma configuração. Escreva as respostas em um documento, o documento de descoberta. Todas as etapas posteriores utilizam esse documento, e a nota de transferência faz referência a ele.

Com quem conversar

  • A pessoa que decide em nome do cliente e será responsável pela organização no CoRoid.
  • Um líder de engenharia para cada repositório onde o CoRoid atuará.
  • As pessoas que revisam e mesclam pull requests atualmente.
  • Segurança ou conformidade, quando o cliente possui regras sobre dados, modelos ou aprovações.
  • O responsável por cada processo de negócio que o fluxo de trabalho abrangerá.

Perguntas a fazer

Pergunte sobre resultados e preocupações, não sobre configurações. Um cliente diz: "ninguém altera o código de pagamento sem revisão". Você descobre a configuração depois.

Objetivos

  • O que deve mudar após 90 dias? Peça uma métrica e seu valor atual, por exemplo: "os bugs que afetam relatórios são corrigidos em uma semana".
  • Qual trabalho o CoRoid deve fazer primeiro? Qual trabalho ele nunca deve fazer?
  • Quem solicita trabalho hoje? Quem pedirá trabalho ao CoRoid?

Sistemas

  • Qual host Git e quais repositórios? O CoRoid consegue acessar o host Git pela internet pública?
  • Como cada repositório compila e executa seus testes? Quais serviços os testes necessitam?
  • Como as pessoas fazem login atualmente? A empresa usa um provedor de identidade com o SSO?
  • Qual ferramenta de chat a equipe utiliza?
  • De onde vêm o trabalho atualmente: um rastreador de issues, um rastreador de erros, uma caixa de entrada de suporte ou uma ferramenta de monitoramento?
  • Quais sistemas internos os agentes precisam ler ou alterar? Existe um servidor MCP para eles?
  • Como o código chega à produção? Quem faz o deploy e em quais dias?

Regras

  • Onde os dados devem permanecer? As chamadas aos modelos do AI devem ficar na UE?
  • Quais provedores de modelo são permitidos? O cliente tem contratos e chaves próprios com os provedores de modelo?
  • Qual código precisa da aprovação de uma pessoa específica antes de ser mesclado? Quem aprova?
  • O que toda alteração deve passar: testes, cobertura, varreduras de segurança, traduções?
  • O que o CoRoid pode iniciar sem intervenção humana? Quanto ele pode gastar por semana ou mês?
  • O que o registro de auditoria deve registrar e por quanto tempo deve ser mantido?

Processos

  • Quais processos de negócio um fluxo de trabalho pode abranger? Para cada um: como um caso começa, quais são as etapas e quais decisões exigem intervenção humana?
  • Quais regras determinam o restante? Escreva-as como linhas: "quando isso, então aquilo".
  • O que deve acontecer quando algo falhar, como uma tarefa ou um deploy com erro?
  • Qual trabalho deve ser executado segundo uma agenda, como uma limpeza semanal?

Pessoas

  • Quem são os proprietários e administradores? Quem solicita trabalho e quem apenas revisa?
  • Quem mantém a configuração após a transferência?

Documento de descoberta

Mantenha o documento curto. Use estas seções, nesta ordem.

  1. Objetivos. Os resultados para o dia 90, cada um com uma métrica e seu valor atual.
  2. Sistemas. O host Git e repositórios, login, chat, rastreadores de issues e erros, ferramentas internas e o caminho para a produção.
  3. Regras. Onde os dados ficam, modelos permitidos, aprovações, as verificações que cada alteração deve passar, orçamentos, auditoria e retenção.
  4. Processos a abranger. Para cada projeto e fluxo de trabalho: o que ele abrange, quem é o proprietário e como saber que funciona.
  5. Pessoas. A função de cada pessoa no CoRoid e quem mantém a configuração após a transferência.
  6. Perguntas em aberto. O que o cliente ainda precisa decidir e até quando.

Para cada regra, escreva onde ela será definida. Configurar lista cada local. Uma regra que nenhuma configuração cobre é um pedido ao CoRoid. Veja Uma necessidade não atendida por nada.

Concluído quando

O cliente lê o documento e concorda com ele. A partir de então, qualquer mudança de plano deve ser inserida no documento primeiro e depois nas configurações.