O software da empresa tem mais de 12 anos de operações, com uma documentação fragmentada e inconsistente. A migração para um sistema mais moderno está sendo implementada, mas as regras de negócio continuam sendo manejadas de forma manual, o que pode levar a erros. Este guia aborda como automatizar e otimizar este processo.
Snapshot da Codebase
Começamos com um snapshot da codebase atual, que serve como base para a documentação das regras de negócio. Este snapshot é uma representação precisa do estado atual do código.
Base Centralizada de Documentação
A próxima etapa é criar uma base centralizada de documentação. Esta base deve ser versionada e independente dos repositórios dos microserviços. Cada regra deve ter um identificador único, descrição, exemplos, exceções conhecidas e referências aos serviços envolvidos.
Integração com Actions
Agora, vamos explorar como integrar a automação com as Actions do GitHub. As Actions podem ser usadas para recolher comentários de PRs, analisar diffs e gerar propostas de atualização na base centralizada. Isso ajudará a garantir que as mudanças sejam documentadas e revisadas.
Testes de Caracterização e Aceitação
Para garantir que as mudanças sejam corretas, é importante criar testes de caracterização do legado e testes de aceitação durante a migração. Estes testes ajudarão a verificar o comportamento esperado e garantir que as regras sejam mantidas corretamente.
Documentação e Testes
A documentação é crucial para preservar os motivos das regras. Os testes de aceitação ajudarão a verificar o comportamento esperado e garantir que as regras sejam mantidas corretamente.
Conclusão
A automação da documentação e manutenção de regras de negócio é crucial para garantir que o sistema funcione corretamente. A base centralizada de documentação, as Actions do GitHub e os testes de caracterização e aceitação são ferramentas essenciais para este processo. Com o tempo, podemos expandir e melhorar esta abordagem para garantir que o sistema continue funcionando conforme esperado.