Criando um assistente com IA para documentação técnica – Parte 1: Por que e como comecei esse projeto?

Este post também está disponível em inglês: Leia em Inglês Oi! Eu sou o Gustavo — desenvolvedor back-end, apaixonado por Java, Python, automações, arquitetura de software e, mais recentemente, por aplicar IA em projetos práticos. Resolvi começar minha jornada de escrita técnica por aqui, compartilhando um pouco das experiências e aprendizados com os projetos que venho criando por conta própria. Sempre acreditei que a melhor forma de aprender é botando a mão na massa: errando, ajustando e resolvendo problemas do mundo real. Então, além de explorar novas ferramentas, decidi também documentar esse caminho — vai que isso ajuda alguém ou rende boas conversas por aqui. O projeto: um assistente com IA para documentação técnica Já se sentiu perdido em meio a uma documentação extensa ou teve dificuldade para entender como uma base de código realmente funciona? Foi pensando nisso — e querendo aprender mais sobre IA, automações e arquitetura — que comecei a desenvolver um projeto pessoal: um assistente inteligente capaz de entender a estrutura de um projeto em Java e responder perguntas como se fosse um “chat interno” da equipe. Por que criei esse projeto? A ideia surgiu durante o desenvolvimento da TrustScore API, uma aplicação em Java com Spring Boot para avaliação de produtos. Eu queria explorar maneiras de automatizar o entendimento da base de código e, ao mesmo tempo, estudar conceitos de IA aplicada ao desenvolvimento de software. Também vi aí uma ótima oportunidade para praticar com: FastAPI e Python em projetos reais Estruturação e extração de dados Design de APIs e arquitetura orientada a dados Integração entre IA e código-fonte Visão geral do projeto O objetivo é criar um sistema em que um assistente com IA possa responder perguntas sobre o código de um projeto. Para isso, defini os seguintes passos: Crawler: script que varre arquivos .java e extrai nomes de classes, métodos, atributos e comentários relevantes. Armazenamento: os dados são organizados e salvos em um banco SQLite local. API com FastAPI: uma API REST que expõe os dados extraídos de forma estruturada. Agente de IA: um modelo de linguagem (LLM) que utilizará os dados da API para responder perguntas de forma natural. Interface: um front-end simples em formato de chat para interagir com a IA. Primeiros passos: construindo o crawler Antes de qualquer IA começar a responder perguntas sobre um código, ela precisa entender o que existe ali dentro. Por isso, comecei criando um crawler simples em Python para analisar a estrutura da aplicação Java que desenvolvi (a TrustScore API). A ideia era extrair informações importantes dos arquivos .java, como: nomes de classes e onde aparecem métodos, suas assinaturas e comentários associados atributos e variáveis relevantes A lógica foi implementada de forma simples: leitura linha a linha dos arquivos, utilizando expressões regulares. Nada sofisticado neste início — o foco era ter algo funcional rapidamente e que rodasse localmente, sem depender de bibliotecas externas mais pesadas. Os dados extraídos são armazenados em um banco SQLite já estruturado para permitir consultas futuras. Essa base será essencial para os próximos passos do projeto — especialmente para alimentar a API e, depois, o modelo de IA. Em breve, vou publicar um post detalhado explicando como criei esse crawler do zero — incluindo o passo a passo, os desafios e como pensei a estrutura de dados. Repositório do projeto no GitHub: https://github.com/gustavogutkoski/ProjectInsight Próximos passos Agora estou trabalhando na criação da API com FastAPI para expor os dados extraídos do código. A ideia é deixá-la pronta para ser consumida por um agente de IA. Depois disso, pretendo: Integrar uma LLM para gerar respostas contextuais Criar um front-end básico com interface de chat Ajustar e enriquecer os dados extraídos para melhorar o contexto das respostas Conclusão Esse projeto tem sido um desafio técnico e criativo — unindo scraping de código, API REST e conceitos de IA em algo que pode ser útil no dia a dia de qualquer time de desenvolvimento. Nos próximos posts, vou detalhar como estou implementando a API e, mais pra frente, como pretendo conectar um modelo de IA a tudo isso. Fico aberto a sugestões, ideias e feedbacks! Me segue aqui no Dev.to e acompanha os próximos capítulos dessa série. ⚙️ Este texto foi escrito com o apoio de uma IA como assistente de escrita e revisão. Todas as ideias, estrutura do projeto e implementações técnicas são de autoria própria.

May 9, 2025 - 14:39

Criando um assistente com IA para documentação técnica – Parte 1: Por que e como comecei esse projeto?

Este post também está disponível em inglês: Leia em Inglês

Oi! Eu sou o Gustavo — desenvolvedor back-end, apaixonado por Java, Python, automações, arquitetura de software e, mais recentemente, por aplicar IA em projetos práticos. Resolvi começar minha jornada de escrita técnica por aqui, compartilhando um pouco das experiências e aprendizados com os projetos que venho criando por conta própria.

Sempre acreditei que a melhor forma de aprender é botando a mão na massa: errando, ajustando e resolvendo problemas do mundo real. Então, além de explorar novas ferramentas, decidi também documentar esse caminho — vai que isso ajuda alguém ou rende boas conversas por aqui.

O projeto: um assistente com IA para documentação técnica

Já se sentiu perdido em meio a uma documentação extensa ou teve dificuldade para entender como uma base de código realmente funciona?

Foi pensando nisso — e querendo aprender mais sobre IA, automações e arquitetura — que comecei a desenvolver um projeto pessoal: um assistente inteligente capaz de entender a estrutura de um projeto em Java e responder perguntas como se fosse um “chat interno” da equipe.

Por que criei esse projeto?

A ideia surgiu durante o desenvolvimento da TrustScore API, uma aplicação em Java com Spring Boot para avaliação de produtos. Eu queria explorar maneiras de automatizar o entendimento da base de código e, ao mesmo tempo, estudar conceitos de IA aplicada ao desenvolvimento de software.

Também vi aí uma ótima oportunidade para praticar com:

FastAPI e Python em projetos reais
Estruturação e extração de dados
Design de APIs e arquitetura orientada a dados
Integração entre IA e código-fonte

Visão geral do projeto

O objetivo é criar um sistema em que um assistente com IA possa responder perguntas sobre o código de um projeto. Para isso, defini os seguintes passos:

Crawler: script que varre arquivos .java e extrai nomes de classes, métodos, atributos e comentários relevantes.
Armazenamento: os dados são organizados e salvos em um banco SQLite local.
API com FastAPI: uma API REST que expõe os dados extraídos de forma estruturada.
Agente de IA: um modelo de linguagem (LLM) que utilizará os dados da API para responder perguntas de forma natural.
Interface: um front-end simples em formato de chat para interagir com a IA.

Primeiros passos: construindo o crawler

Antes de qualquer IA começar a responder perguntas sobre um código, ela precisa entender o que existe ali dentro. Por isso, comecei criando um crawler simples em Python para analisar a estrutura da aplicação Java que desenvolvi (a TrustScore API).

A ideia era extrair informações importantes dos arquivos .java, como:

nomes de classes e onde aparecem
métodos, suas assinaturas e comentários associados
atributos e variáveis relevantes

A lógica foi implementada de forma simples: leitura linha a linha dos arquivos, utilizando expressões regulares. Nada sofisticado neste início — o foco era ter algo funcional rapidamente e que rodasse localmente, sem depender de bibliotecas externas mais pesadas.

Os dados extraídos são armazenados em um banco SQLite já estruturado para permitir consultas futuras. Essa base será essencial para os próximos passos do projeto — especialmente para alimentar a API e, depois, o modelo de IA.

Em breve, vou publicar um post detalhado explicando como criei esse crawler do zero — incluindo o passo a passo, os desafios e como pensei a estrutura de dados.

Repositório do projeto no GitHub: https://github.com/gustavogutkoski/ProjectInsight

Próximos passos

Agora estou trabalhando na criação da API com FastAPI para expor os dados extraídos do código. A ideia é deixá-la pronta para ser consumida por um agente de IA.

Depois disso, pretendo:

Integrar uma LLM para gerar respostas contextuais
Criar um front-end básico com interface de chat
Ajustar e enriquecer os dados extraídos para melhorar o contexto das respostas

Conclusão

Esse projeto tem sido um desafio técnico e criativo — unindo scraping de código, API REST e conceitos de IA em algo que pode ser útil no dia a dia de qualquer time de desenvolvimento.

Nos próximos posts, vou detalhar como estou implementando a API e, mais pra frente, como pretendo conectar um modelo de IA a tudo isso.

Fico aberto a sugestões, ideias e feedbacks!

Me segue aqui no Dev.to e acompanha os próximos capítulos dessa série.

⚙️ Este texto foi escrito com o apoio de uma IA como assistente de escrita e revisão. Todas as ideias, estrutura do projeto e implementações técnicas são de autoria própria.