Como montar o mapa
| O que mapear | Como |
|---|---|
| Telas e rotas | Arquivos de rotas ou estrutura de pastas; navegação no sistema |
| Banco de dados | Tabelas, relações e volumes |
| Rotinas automáticas | Cron do servidor, filas, scripts soltos |
| Integrações | Chamadas a APIs, envio de e-mail, pagamentos |
| Configurações | Arquivos de ambiente e constantes espalhadas |
| Regras de negócio | Leitura do código nos fluxos críticos + conversa com usuários |
Ouça quem usa
Os usuários sabem o que o sistema faz, inclusive os contornos que criaram para conviver com erros. Uma conversa com quem usa cada área revela regras que não estão escritas em lugar nenhum e prioridades reais.
Proteja antes de alterar
Em código sem documentação e sem testes, cada mudança pode quebrar algo distante. Uma técnica útil é criar testes de caracterização: testes que registram o comportamento atual dos fluxos críticos (mesmo que tenha falhas), para que qualquer mudança inesperada seja percebida.
Documente o mínimo útil
- Como instalar e rodar o sistema localmente
- Como publicar uma nova versão
- Mapa de rotinas automáticas e integrações
- Regras de negócio importantes
- Problemas conhecidos
Leia também
Veja o que entregar ao novo desenvolvedor e, se o código mistura PHP, HTML e JavaScript, como corrigir sistemas com PHP, jQuery e HTML. Assumimos sistemas sem documentação no nosso serviço de manutenção de sistemas PHP e Laravel.