image

Bootcamps ilimitados + curso de inglés para sempre

80
%OFF
Article image
Diogo Silva
Diogo Silva09/04/2025 00:52
Compartir
Microsoft Certification Challenge #3 DP-100Recomendado para tiMicrosoft Certification Challenge #3 DP-100

🚀 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

Compartir
Recomendado para ti
Microsoft 50 Anos - Prompts Inteligentes
Microsoft 50 Anos - GitHub Copilot
Microsoft 50 Anos - Computação em Nuvem com Azure
Comentarios (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?

Recomendado para tiMicrosoft Certification Challenge #3 DP-100