Article image
Diogo Silva
Diogo Silva09/04/2025 00:52
Compartilhe

🚀 GIT + IA: A Fórmula Secreta para Relatórios Técnicos Sem Esforço (E Mais Tempo Livre!)

  • #Git

Você já passou por isso: o fim da sprint chega, e o líder da equipe cobra aquele relatório técnico detalhado. Você vasculha commits, tira prints tortuosos, cola tudo num Word e torce pra ninguém perceber que esqueceu algo. Horas de código viram horas de retrabalho — e o pior: seu esforço nem sempre é bem reconhecido. Eu também já estive nesse looping frustrante.

Descubra como usar o git log com IA e transforme seus relatórios técnicos em evidências automáticas, claras e profissionais. O que antes era um pesadelo de documentação, agora vira um processo de minutos — te dando tempo livre e um destaque que você nunca imaginou. Quer saber como? Eu vou te mostrar o passo a passo dessa fórmula secreta.

🧩 O Pesadelo da Documentação Manual (E Por Que Você Não Merece Isso)

Todo dev conhece essa rotina:

  • Prints caóticos: Capturas de tela que não explicam nada direito.
  • Memória falha: "O que eu fiz mesmo naquele commit 'ajustes'?"
  • Relatórios genéricos: Horas perdidas pra algo que ninguém lê com atenção.

O resultado? Você entrega um código incrível, mas a evidência não reflete seu esforço. A pressão aumenta, o tempo some, e o reconhecimento fica aquém. Prestar contas não deveria ser mais difícil que codar — e não precisa ser.

🔧 A Solução: Usar GIT como fonte oficial de verdade Automática

Eu uso o seguinte comando para gerar um arquivo com os commits da sprint:

git log --since="2025-04-01" --until="2025-04-14" --date=short --pretty=format:"%h - %ad: %s (%an)" -p > evidencia.txt

O que isso faz?

  • %h: Hash curto do commit (identificador único).
  • %ad: Data da alteração (prova temporal).
  • %s: Mensagem do commit (o que você fez).
  • (%an): Seu nome (crédito garantido).
  • -p: adiciona o diff, ou seja, mostra linha a linha o que foi alterado no código: o que foi adicionado (+) e o que foi removido (-).
  • > evidencia.txt: Exporta tudo num arquivo limpo.

Esse TXT é sua matéria-prima. Agora, a IA entra pra transformar isso em ouro.

🧠 Prompt IA Aprimorado para Geração de Relatório Técnico com GIT

"Para gerar um relatório técnico detalhado a partir do histórico de commits, utilizo o seguinte prompt na IA:
Com base no histórico de commits abaixo, gere um relatório técnico de evidência de desenvolvimento detalhado.
Para cada commit, forneça:
O objetivo principal da alteração.
Os módulos ou funcionalidades impactadas.
Se houve criação de novas classes ou métodos, descreva seus nomes prováveis e responsabilidades.
Se houve alteração em métodos existentes, especifique as mudanças mais prováveis (como adição de parâmetros, mudanças de lógica, refatoração de nomes, responsabilidades, retorno, etc.).
Comente sobre possíveis tecnologias, frameworks, padrões de projeto ou bibliotecas envolvidas.
Explique o impacto técnico e de negócio da alteração.
Use uma linguagem técnica clara e orientada a quem fará leitura posterior do relatório (como gestor técnico ou auditor).
Utilize o campo "Contexto" abaixo (quando preenchido) para enriquecer a análise com informações específicas da tarefa ou do requisito.
Contexto (opcional): [insira aqui o contexto do commit, se disponível]
Histórico de commits: [cole aqui o conteúdo do evidencia.txt]"

🧪 Exemplo Real e Complexo com Commits Simulados

Considere o seguinte histórico de commits simulado de um projeto de e-commerce:

b8d2a7f - 2025-04-11: feat: Implementa autenticação JWT para API (Diogo Santos)
e5c1b9a - 2025-04-11: fix: Corrige bug na lógica de cálculo de desconto (Diogo Santos)
f9a3d1c - 2025-04-12: refactor: Otimiza query de listagem de produtos com índices (Diogo Santos)
c4e7b2d - 2025-04-12: feat: Adiciona exportação de relatórios em formato CSV (Diogo Santos)

📋 Saída da IA:

Commit: b8d2a7f

  • Objetivo: Implementar autenticação JWT para proteger rotas da API.
  • Módulos Impactados: Autenticação, segurança, filtros de requisição.
  • Criações Prováveis:
  • Classe JwtTokenService para geração e validação de tokens.
  • Classe JwtAuthenticationFilter interceptando requisições.
  • Endpoint /auth/login retornando token.
  • Alterações em Métodos Existentes:
  • Inclusão de validação de token em middleware.
  • Tecnologias: Spring Security, jjwt.
  • Impacto Técnico: Rotas seguras com token no header Authorization.
  • Impacto de Negócio: Proteção de dados sensíveis.

Commit: e5c1b9a

  • Objetivo: Corrigir erro na aplicação de descontos múltiplos.
  • Módulos Impactados: Carrinho, precificação.
  • Criações Prováveis:
  • Método validarDescontoCumulativo() no CarrinhoService.
  • Alterações:
  • Ajuste lógico no método calcularTotalComDesconto().
  • Tecnologias: Java, regras de negócio customizadas.
  • Impacto Técnico: Cálculo correto, sem sobreposição de descontos.
  • Impacto de Negócio: Redução de perdas por descontos indevidos.

Commit: f9a3d1c

  • Objetivo: Otimizar listagem de produtos no banco.
  • Módulos Impactados: Produto, banco de dados.
  • Alterações:
  • Refatoração da query principal.
  • Criação de índice no campo categoria_id.
  • Tecnologias: SQL, Hibernate.
  • Impacto Técnico: Redução do tempo de resposta.
  • Impacto de Negócio: Melhor experiência de navegação.

Commit: c4e7b2d

  • Objetivo: Permitir exportar relatórios em CSV.
  • Criações:
  • Classe CsvExportService com método gerarCsv().
  • Alterações:
  • Inclusão de botão no frontend, rota /relatorio/exportar.
  • Tecnologias: Java, OpenCSV.
  • Impacto Técnico: Geração automatizada de arquivos.
  • Impacto de Negócio: Facilidade na extração de dados para gestores.

🔁 Fluxo: Simples e Poderoso

Esse diagrama mostra, passo a passo, o processo de transformar seus commits em um relatório técnico usando GIT + IA.

Aqui está a explicação:

  1. 💻 Commits no GIT
  2. → Você está trabalhando normalmente, versionando o código.
  3. 📜 git log > evidencia.txt
  4. → Você executa o comando git log e gera um arquivo evidencia.txt com o histórico de commits.
  5. 🧠 IA + Prompt Técnico
  6. → Você alimenta esse arquivo em uma Inteligência Artificial com um prompt estruturado.
  7. 📋 Relatório Profissional
  8. → A IA devolve um relatório técnico pronto, com explicações claras, impacto técnico e de negócio.

🌟 Por Que Isso Vai Mudar Sua Vida Dev?

  • Produtividade: Automatize o chato, foque no código.
  • Credibilidade: Evidências detalhadas mostram seu valor.
  • Tempo: Horas salvas viram aprendizado ou descanso.
  • Destaque: Você vira o dev que "pensa além".

📢 E você, como tem lidado com a documentação técnica no fim da sprint?

📝 Já ficou preso em relatórios manuais?

🤖 Já tentou alguma automação com GIT e IA?

💬 Conta nos comentários como é seu processo hoje — ou qual foi o maior perrengue que já enfrentou nessa parte do trabalho.

🔄 Vamos abrir essa conversa. Às vezes, uma dica que você compartilha resolve o problema de outro dev — e vice-versa.

👥 A comunidade cresce quando a gente discute o que realmente acontece na trincheira do código.

#GIT #EvidênciaDeDesenvolvimento #IA #ProdutividadeDev

Compartilhe
Comentários (8)

VA

Vinicius Alves - 15/04/2025 11:56

Parabéns pelo seu artigo ! Genial !

ML

Marlon Lorram - 11/04/2025 11:47

Top demais o artigo, parabéns!!

JM

Jose Melo - 10/04/2025 17:31

Que conteúdo fantástico, Diogo!

Transformar git log em relatórios técnicos automatizados com IA é simplesmente genial — resolve um problema real que consome tempo e raramente entrega o devido reconhecimento.

Gostei especialmente do prompt estruturado e da forma como você conecta os commits com impacto técnico e de negócio. Isso dá muito mais peso à entrega de valor da equipe.

Já estou pensando em como adaptar essa abordagem aqui no time.

Você já chegou a integrar esse processo com alguma ferramenta de CI/CD ou gestão de sprints (tipo Jira ou Azure DevOps)? Acho que daria uma sinergia poderosa.

Parabéns pela iniciativa de compartilhar algo tão prático e aplicável!

G

Guilherme - 10/04/2025 16:00

Muito claro e muito intuitivo

MM

Marcelo Monteiro - 10/04/2025 15:28

Diogo, seu artigo sobre a criação de relatórios técnicos de sprint com git log e IA é excelente! A abordagem é clara, prática e resolve um problema comum no desenvolvimento. A combinação das ferramentas é inovadora e muito útil. Os exemplos e o passo a passo facilitam a compreensão, mesmo para quem não tem experiência. A ênfase nos benefícios, como produtividade e reconhecimento, mostra a importância da sua solução. Parabéns pela ótima contribuição à comunidade! Abraço.

Diogo Silva
Diogo Silva - 10/04/2025 10:09

Olá DIO Community! Muito obrigado pelo feedback tão positivo! Fico feliz em saber que o artigo ressoou com vocês e que a DIO também está incentivando a automação e as boas práticas.

A pergunta sobre o uso da IA para revisar e sugerir melhorias no código dentro do Git, especialmente para otimizar os pull requests, é extremamente relevante e promissora. Eu vejo um potencial enorme para a IA transformar essa etapa do desenvolvimento, que muitas vezes é um gargalo no fluxo de trabalho.

Integração no CI/CD e Feedback:

A análise de código por IA pode ser integrada ao pipeline de CI/CD, geralmente após a compilação e os testes unitários, mas antes da integração com o ambiente de produção. Ferramentas como Jenkins, GitLab CI/CD e GitHub Actions permitem essa integração, onde a IA analisa o código em cada pull request. O feedback pode ser fornecido diretamente nos comentários do pull request ou em relatórios detalhados, mostrando problemas de estilo, possíveis bugs e sugestões de refatoração. Isso ajuda a automatizar a revisão, reduzir o tempo gasto pelos revisores humanos e melhorar a qualidade do código.

Feedback para o Desenvolvedor e Aprovador:

Para o desenvolvedor, a IA pode fornecer feedback instantâneo no editor de código, comentar linhas específicas no pull request e gerar relatórios detalhados. Para o aprovador, a IA pode gerar resumos da análise, indicar o status do pipeline e comparar a qualidade do código com versões anteriores. Isso agiliza a identificação e correção de problemas, além de garantir a consistência do código.

Análise de Código Antes do Commit:

Embora a automatização no CI/CD seja valiosa, é ainda mais eficiente abordar os problemas de código antes mesmo de serem commitados. A IA pode ser usada para analisar o código durante o desenvolvimento, fornecendo feedback precoce e evitando a propagação de problemas.

Análise Semântica e Arquitetural:

A IA pode ir além da análise sintática, analisando a semântica do código, ou seja, o que ele realmente faz. Isso permite que a IA verifique se o código está obedecendo à arquitetura do projeto, aos princípios SOLID e aos padrões de design.

Geração de TXT para Análise:

Para facilitar a análise pela IA, podemos gerar um arquivo TXT com o código-fonte usando um script como este (exemplo em batch para Windows):

@echo off
setlocal enabledelayedexpansion

:: Obter o nome da pasta atual
for %%I in (.) do set "CURRENT_FOLDER=%%~nxI"

:: Obter a data e hora no formato yyyymmddhhmmss
for /f "tokens=2 delims==" %%I in ('wmic os get localdatetime /value') do set datetime=%%I
set OUTPUT_FILE=%CURRENT_FOLDER%_%datetime:~0,4%%datetime:~4,2%%datetime:~6,2%%datetime:~8,2%%datetime:~10,2%%datetime:~12,2%.txt

:: Criar o arquivo de saída
echo Gerando %OUTPUT_FILE%...

:: Percorrer todos os arquivos .java, .xml e .xhtml nas pastas e subpastas
for /r %%F in (*.java *.xml *.xhtml) do (
  echo ----- %%F ----- >> "%OUTPUT_FILE%"
  type "%%F" >> "%OUTPUT_FILE%"
  echo. >> "%OUTPUT_FILE%"
)

echo Processo concluído. Arquivo gerado: %OUTPUT_FILE%
pause

Esse script percorre os arquivos especificados e os salva em um TXT, que pode ser fornecido como entrada para a IA.

Benefícios e Desafios:

A aplicação da IA na análise de código em todas as fases do desenvolvimento, desde a escrita até a integração contínua, tem o potencial de revolucionar a qualidade do software e a produtividade das equipes. No entanto, desafios como a necessidade de treinar a IA com grandes volumes de dados, lidar com falsos positivos/negativos e garantir a interpretação humana dos resultados ainda precisam ser superados.

O que vocês acham dessa abordagem mais abrangente?

Quais ferramentas e técnicas vocês usam para garantir a qualidade do código em suas equipes?


F

Fernando - 10/04/2025 09:24

Parabéns pelo artigo Diogo! Você conseguiu abordar de forma clara e prática um problema que muitos desenvolvedores enfrentam: a elaboração de relatórios técnicos no final das sprints. A solução apresentada, que combina o uso do `git log` com inteligência artificial, é não apenas inovadora, mas também extremamente aplicável no dia a dia. Os exemplos concretos e a explicação passo a passo tornam o conteúdo acessível, mesmo para aqueles que não estão familiarizados com essas ferramentas. Além disso, destacar os benefícios, como o aumento da produtividade e o reconhecimento profissional, reforça a relevância dessa abordagem no ambiente de desenvolvimento atual. Excelente contribuição para a comunidade de desenvolvedores! Forte abraço.

DIO Community
DIO Community - 09/04/2025 14:42

Diogo, seu artigo sobre como usar Git para gerar relatórios técnicos com a ajuda da IA foi incrível! A abordagem que você propôs, usando o git log e integrando com IA para automatizar a criação de relatórios detalhados e profissionais, é uma solução eficiente e inovadora. Com isso, você consegue economizar tempo e aumentar a produtividade, deixando o processo de documentação muito mais ágil e assertivo. A demonstração de como o fluxo funciona, desde a coleta dos commits até a geração do relatório técnico, foi clara e prática, proporcionando uma ótima visão para desenvolvedores que buscam otimizar suas tarefas.

Na DIO, também incentivamos a adoção de automação e boas práticas, principalmente em cursos de DevOps e ferramentas de CI/CD, onde a integração de tecnologias como Git e IA tem sido explorada. Muitos dos nossos alunos estão experimentando automações para reduzir retrabalho, como você fez.

Como você enxerga o uso da IA para revisar e sugerir melhorias no código dentro do Git, especialmente para otimizar o processo de pull requests e reduzir o tempo gasto com revisões manuais?