Sobre o Tech Docs

Sobre o Tech Doc

O Tech Doc é um módulo do Code Shift que automatiza a criação de documentação técnica a partir do código-fonte do seu repositório no GitHub, importado para a StackSpot AI.

Ele analisa o código e gera automaticamente uma documentação estruturada e pronta para uso por times de desenvolvimento, arquitetura e auditoria.

A documentação é baseada em informações como dependências, tipos, métodos e relacionamentos encontrados nos arquivos do código. O resultado é entregue diretamente como um Pull Request (PR) no repositório.

O Tech Doc suporta diversas linguagens, como Java, Python, JavaScript, TypeScript, C#, Kotlin, Go, Swift, Rust, entre outras.

Quais são os benefícios?

• Automação e eficiência: economize tempo e esforço ao documentar sistemas, com um processo automatizado;
• Padronização: garanta que as documentações sigam um padrão único e as boas práticas da empresa;
• Menos riscos: reduza erros e problemas de compliance ao automatizar a coleta e registro de informações importantes do código;
• Segurança: integrações com StackSpot são seguras e protegidas contra acessos indevidos;
• Rastreabilidade: todas as análises e resultados ficam salvos com logs detalhados, facilitando auditorias e consultas futuras.

Exemplos de uso

Confira alguns exemplos como você pode usar o módulo:

• Onboarding de novos membros: ajude quem está entrando no time a entender o sistema mais rápido com a documentação atualizada e alinhada ao padrão corporativo.

• Auditorias e compliance: gere relatórios claros sobre o código, facilitando auditorias e atendendo exigências regulatórias;

• Refatoração e melhorias: identifique dependências e pontos críticos para modernizar ou melhorar sistemas antigos.

Quais os tipos de documentação gerada

README.md

Arquivo de apresentação que fica na raiz do repositório. É o primeiro contato de quem acessa o projeto.

• Objetivo: apresentar o projeto de forma rápida e prática;
• Público-alvo: quem está avaliando ou começando a usar o projeto;
• Formato: curto e direto, para facilitar o início do uso;
• Conteúdo: o que é o projeto, como instalar e configurar, como rodar localmente, informações básicas de contribuição e suporte;

DOCUMENTATION.md (documentação detalhada)

Arquivo com informações completas sobre o projeto, voltado para uso avançado e manutenção.

• Objetivo: detalhar regras, arquitetura, integrações e funcionamento do projeto;
• Público-alvo: desenvolvedores e profissionais que precisam entender ou evoluir o sistema;
• Formato: dividido em seções, pode ser hospedado no GitHub Pages do produto;
• Conteúdo: visão geral, regras de negócio, arquitetura, endpoints, modelo de dados, testes, observabilidade, segurança, entre outros;

Resumo das diferenças

Aspecto	README.md	DOCUMENTATION.md
Propósito	Introdução e visão geral	Detalhamento técnico e funcional
Tamanho	Curto e direto	Extenso e detalhado
Público-alvo	Usuários iniciantes	Usuários avançados e desenvolvedores
Conteúdo	Resumo, instalação, uso básico	Regras de negócio, arquitetura, API, dados, testes, observabilidade, segurança