CDT: Central de Documentação Técnica

Desafio

Update Sets eram promovidos para produção sem documentação adequada, sem revisão de código, sem validação técnica e sem rastreabilidade.

O resultado eram incidentes em produção, retrabalho, conhecimento que se perdia quando alguém saía do projeto e dificuldade para responder a auditorias. Faltava um portão de qualidade obrigatório antes de cada deploy.

Como funciona

O que eu fiz

• Modelo de dados, Script Includes, telas e fluxo de aprovação desenhados e desenvolvidos por mim.
• Geração: uma UI Action na release cria um registro de documentação por release e vincula todos os Update Sets, cada um com o seu code review.
• Documentação automática: um Script Include lê os registros do Update Set (sys_update_xml) e monta um relatório HTML com os artefatos alterados, com nome amigável, ação, ícone e link. O desenvolvedor anexa as evidências de teste, cada uma com descrição.
• Code review manual: o revisor marca cada artefato como aprovado ou não aprovado, com comentário.
• Code review automático: um motor com 16 regras estáticas, classificadas em erro, aviso e informação, cada uma com explicação. Exemplos: GlideRecord sem filtro, updateMultiple, sys_id fixo no código, contorno de ACL, falta de tratamento de erro e complexidade excessiva.
• Instance Scan: os scans e findings de cada Update Set aparecem com a severidade, no mesmo lugar.
• Regras de negócio: a documentação só é concluída com pelo menos um anexo de evidência, só o Líder Técnico aprova ou reprova, e a edição é bloqueada depois da conclusão.

Quem participa

• Desenvolvedor: gera e completa a documentação, anexa as evidências e corrige o que for apontado.
• Líder Técnico: revisa o código, analisa os achados automáticos e aprova ou reprova.
• Analista de Release: faz a subida dos Update Sets aprovados, dentro do rito do CAB.

Resultado

• Toda release passa a ter documentação técnica padronizada, com evidências de teste anexadas.
• Problemas de código são apontados antes da produção, com regras explicadas que também ensinam o time.
• Rastreabilidade completa de quem documentou, revisou, aprovou e subiu cada Update Set, o que facilita auditorias.

Tecnologias

• ServiceNow
• Script Includes
• UI Actions
• Instance Scan
• Release Management
• ACLs