Como usar o DocGen
DocGen é um assistente que lê o código-fonte do seu projeto .NET e produz documentação técnica e funcional automaticamente, com apoio de IA.
Primeiros passos
- Abra a aba Menu no topo.
- Localize a funcionalidade que deseja documentar — o menu é o mesmo do sistema (Pessoa Física, Registro de Emprego, Lançamentos, etc.).
- Clique no item desejado (ex: Registrar Empregado).
- No painel que abre, clique em Documentação Base.
- Acompanhe o agente navegar pelo código em tempo real.
- Pronto — a documentação aparece no painel e fica salva em Documentações.
Tipos de documentação
- Base: visão geral da tela — campos, regras, fluxos. Ponto de partida.
- Produto: documentação de negócio para validação pela equipe de produto — fluxos, regras, campos e impactos, sem detalhes técnicos.
A documentação de Produto depende de uma documentação base já gerada para a mesma tela.
Como usar o chat
Vá até a aba Chat para tirar dúvidas sobre as telas que você documentou.
- Cada conversa fica salva e pode ser retomada depois.
- Se a tela mencionada na pergunta ainda não foi documentada, o assistente sugere gerar a documentação na hora.
- Quanto mais específica for a pergunta, melhor a resposta.
Atalhos de teclado
- Ctrl+1 a Ctrl+5 — alterna abas
- Ctrl+K — foca o campo de busca da aba atual
- Esc — fecha diálogos abertos
- Enter no chat — envia mensagem
- Shift+Enter no chat — quebra de linha
Perguntas frequentes
O DocGen funciona offline?
Não. Ele usa o modelo Gemini (Google), que precisa de conexão e API key configurada no backend.
Quanto tempo demora para gerar uma documentação?
Depende do tamanho da tela. A base costuma levar entre 1 e 3 minutos.
Posso re-gerar uma documentação?
Sim. Selecione a tela novamente e clique no botão de geração — o arquivo anterior é sobrescrito.
Onde ficam minhas conversas do chat?
As conversas ficam salvas na sua conta, no backend do DocGen.