Conheça o Code Analysis: documentação de sistemas com IA, das fontes aos manuais

O que é o Code Analysis?

O Code Analysis é um aplicativo de análise e documentação de sistemas com inteligência artificial. Ele reúne entrevistas, anotações, scripts SQL e telas em projetos, para ajudar você a transformar essas fontes em documentos, diagramas e manuais que podem ser revisados e editados.

Pense no trabalho de entender um sistema já em uso. Uma pessoa explica o processo em uma entrevista, o banco de dados revela a estrutura das informações e a interface mostra como a operação acontece. Cada fonte responde a uma parte da pergunta. O Code Analysis oferece um espaço para trabalhar com elas em conjunto.

A proposta é apoiar quem precisa compreender, explicar ou evoluir um software: organizar o conhecimento, produzir uma primeira versão da documentação e refiná-la com as pessoas que conhecem o negócio.

Para quem precisa entender o sistema e explicar como ele funciona

Analistas de sistemas e de negócios, consultores de implantação, desenvolvedores e profissionais responsáveis por documentação encontram desafios parecidos: informações espalhadas, regras que existem apenas na memória das pessoas e materiais que precisam acompanhar a evolução do produto.

O Code Analysis pode apoiar a descoberta de requisitos, o entendimento de um banco existente, a documentação funcional de telas e a preparação de procedimentos para treinamento e operação. O ponto de partida pode ser pequeno: um processo, um conjunto de tabelas ou uma tela importante.

• Na análise: organizar atores, objetivos, regras e perguntas que ainda precisam de resposta.
• Na implantação: conectar o que foi dito nas entrevistas com os dados e as telas do sistema.
• Na documentação: construir materiais que outras pessoas possam consultar, revisar e usar no dia a dia.

Da entrevista aos casos de uso e diagramas

Uma entrevista costuma misturar objetivos, etapas, exceções e detalhes da operação. Ao levar esse material para o projeto, você pode usar a IA para organizar a análise e construir diagramas com fonte PlantUML editável.

Nos casos de uso, por exemplo, o trabalho é identificar quem interage com o sistema e o que essa pessoa precisa realizar. Diagramas de atividade ajudam a discutir o fluxo; diagramas de sequência, as interações; e outros formatos permitem explorar a estrutura e a arquitetura. A biblioteca de soluções apresenta os tipos disponíveis.

O valor está na conversa que o diagrama permite ter. Você confere se os atores fazem sentido, se uma exceção foi esquecida e se o comportamento descrito corresponde à operação real. A fonte PlantUML fica disponível para ajustes e exportação.

Do SQL ao dicionário de dados e às relações do banco

Quando a documentação do banco está incompleta, um script SQL é uma fonte importante para começar. No Code Analysis, você pode trabalhar com essa estrutura para obter um dicionário de dados e uma fonte de diagrama relacional, e desenvolver a análise no contexto do projeto.

Tabelas, campos e relacionamentos ajudam a entender onde as informações vivem e como se conectam. A extração estrutural básica parte da leitura do SQL. A interpretação do negócio se beneficia das entrevistas, das regras registradas e da revisão do analista.

Uma coluna chamada status, sozinha, não explica quando um pedido pode ser aprovado. A estrutura do banco e o relato da operação se complementam: você documenta o que está explícito e identifica o que ainda precisa ser confirmado.

Das telas a uma documentação que orienta o uso

Uma tela concentra parte importante da experiência do usuário: campos, ações, mensagens e organização das informações. O Code Analysis permite reunir imagens de telas e documentação funcional, mantendo o texto e a referência visual próximos durante a revisão.

Para construir um manual, você seleciona as telas pertinentes e conecta esse material às entrevistas e ao contexto do projeto. Assim, o documento pode explicar uma tarefa completa, em vez de apresentar apenas uma lista de campos.

O fluxo de manuais inclui revisão de consistência. Você pode conferir as relações entre fontes e conteúdo, refinar o resultado e acompanhar suas versões. Antes da entrega, valide os passos no sistema documentado, especialmente permissões, mensagens e situações de exceção.

Um chat que trabalha com o contexto do projeto

O assistente pode consultar módulos, artefatos e relatórios do projeto, além de criar ou atualizar documentos em Markdown e PlantUML. Isso permite continuar a análise em uma conversa: pedir uma explicação, aprofundar um ponto ou revisar um conteúdo que já existe.

Uma pergunta útil seria: “Compare este procedimento com as fontes e destaque o que precisa de confirmação”. Outra: “Organize estas regras em um documento para revisão”. A pergunta direciona a tarefa; as fontes do projeto dão contexto ao trabalho.

O Code Analysis também permite escolher modelos de IA por finalidade, entre as opções elegíveis e disponíveis. Texto, imagem e conversa podem exigir capacidades diferentes. Você consulta a estimativa antes de autorizar a operação e acompanha o consumo na carteira.

As alterações em documentos podem ser acompanhadas pelo histórico de versões. Revise a mudança e, quando necessário, restaure uma versão anterior. A IA ajuda a produzir e organizar; a validação do significado continua com quem conhece o sistema.

Como começar com um projeto real

Escolha um recorte que você consiga validar. Documentar um processo bem delimitado costuma ser um começo mais útil do que tentar descrever o sistema inteiro de uma vez.

1. Crie um projeto e reúna as fontes que você está autorizado a utilizar: anotações, entrevistas, SQL e imagens de telas.
2. Defina a entrega: entender um processo, documentar uma estrutura, construir um diagrama ou preparar um manual.
3. Selecione o contexto e o modelo pertinente, confira a estimativa e autorize a operação de IA.
4. Revise o resultado junto às fontes. Corrija interpretações, confirme regras e registre as dúvidas restantes.
5. Organize a entrega e use as exportações disponíveis, como documentos em Markdown ou DOCX e fontes PlantUML.

Clareza também sobre uso, créditos e dados

Os planos individuais e seus limites estão na página de planos. As operações de IA e as transferências tarifadas utilizam o mesmo saldo de CodeCredits; a interface apresenta a estimativa ou a cotação pertinente antes da autorização. A carteira reúne saldo, reservas e histórico de uso.

Para manter este guia útil enquanto a oferta evolui, preços, quantidades de créditos, validade e condições comerciais ficam concentrados no site. Consulte essas informações ao escolher o plano para o seu trabalho.

Use fontes que você tenha autorização para processar e confira a política de privacidade para entender o tratamento por fornecedores, a retenção e a exclusão. Ao compartilhar documentação, revise também as informações presentes nas imagens e nos exemplos.

Transforme uma tarefa concreta em documentação útil

Pense em uma pergunta que hoje é difícil responder sobre o seu sistema: quem pode aprovar uma operação, como duas tabelas se relacionam ou quais passos uma pessoa precisa seguir para concluir uma tarefa. Essa pergunta ajuda a escolher as fontes e definir o documento que vale a pena produzir.

Um bom resultado permite que outra pessoa compreenda o processo, encontre a informação de que precisa e saiba o que ainda depende de confirmação. No Code Analysis, você pode trabalhar do SQL ao dicionário de dados, das entrevistas aos casos de uso e das telas aos manuais, mantendo as fontes próximas da análise.

Explore os exemplos do aplicativo, escolha uma dessas jornadas e defina o primeiro recorte do seu projeto. Se precisar de orientação para encontrar o fluxo mais adequado ao seu trabalho, fale com a gente pelo suporte.