Doctective
Doctective · Programação
O Doctective é uma ferramenta de documentação com IA que mantém seu README e sua documentação interna em sincronia com o código, e trata a documentação automatizada como algo que roda a cada commit, não como um projeto que você agenda uma vez por trimestre. Ele se conecta ao GitHub, lê cada pull request e descobre qual documentação o seu commit acabou de deixar errada. Em vez de te encher com um aviso, ele abre um PR complementar com correções sugeridas por IA que você pode revisar e mesclar. Esse é o tipo de análise de pull requests que quase nenhuma equipe arruma tempo para fazer à mão. A proposta é simples: instale uma vez e a manutenção da documentação deixa de ser aquela tarefa que você esquece até alguém novo reclamar.
Sobre Doctective
O que é o Doctective
O Doctective é uma ferramenta para desenvolvedores construída em torno de um problema teimoso: o código muda o tempo todo e a documentação não. Quando alguém renomeia uma função, altera uma flag de configuração ou reescreve um endpoint, os documentos que descrevem esse comportamento ficam desatualizados sem aviso. Ninguém percebe até custar a alguém uma tarde inteira.
O Doctective vigia essa deriva. Ele indexa sua base de código e sua documentação e então traça vínculos semânticos entre as duas. Quando um pull request toca código ao qual um documento faz referência, a ferramenta sinaliza as páginas afetadas e redige um PR complementar com as atualizações sugeridas. Você continua aprovando tudo, mas a primeira passada já está feita.
Vale ser claro sobre o escopo. O Doctective lê código-fonte e documentação, então vive em fluxos de trabalho de desenvolvimento, não em sites de marketing ou wikis de clientes. Se a sua equipe não usa o GitHub, provavelmente você não é o público.
Isso significa que ele só ajuda quem tem documentação bagunçada? Não exatamente, porque até equipes disciplinadas deixam um único refactor deixar três páginas descrevendo o comportamento antigo.
Como começar
- Acesse doctective.app e clique em Get Started, o que inicia uma conexão com o GitHub.
- Instale o GitHub App do Doctective e conceda acesso aos repositórios que você quer monitorar.
- Escolha quais repos indexar. O Doctective começa a construir vínculos semânticos entre seu código e sua documentação na hora.
- Abra um pull request como de costume. Quando ele tocar código documentado, o Doctective comenta no PR e abre um PR complementar com edições sugeridas para os documentos.
- Revise as mudanças sugeridas, ajuste o texto se precisar e mescle o que quiser manter.
Informações do produto
Uma visão rápida dos preços, das plataformas compatíveis e do desempenho de Doctective.
Ideal para
Os usuários, tarefas e cenários em que esta ferramenta se encaixa melhor.
Usuários
- Desenvolvedores de backend e plataforma
- Equipes de engenharia de startups
- Mantenedores de código aberto
- Líderes técnicos e revisores
Tarefas
- Detectar documentação desatualizada após uma mudança de código
- Redigir atualizações de documentação
- Auditar a cobertura da documentação
- Preparar revisões de integração
Cenários
- Publicar uma mudança que quebra uma API
- Renomear ou refatorar uma função central
- Limpeza de documentação no fim do sprint
- Adotar documentação como código
Principais recursos
Detecção do impacto de um PR
O Doctective analisa pull requests para descobrir qual documentação uma mudança de código afeta. Ele constrói vínculos semânticos entre seus arquivos-fonte e seus documentos, então quando uma função ou uma flag muda, ele sabe quais páginas dependem disso. Você recebe uma lista clara dos documentos afetados em vez de adivinhar, e a revisão acontece enquanto o raciocínio por trás da mudança ainda está fresco na cabeça de todo mundo.
Geração de PR complementar
Em vez de apenas te avisar, o Doctective abre um segundo pull request com atualizações sugeridas para a documentação. As mudanças ficam no seu fluxo normal de revisão, o que significa que você pode editá-las, rejeitá-las ou mesclá-las como qualquer outro diff, e toda a troca permanece dentro do pull request onde a mudança original já vive. Ele tira o problema da página em branco da manutenção de documentos, que costuma ser o verdadeiro motivo pelo qual o trabalho de documentação trava.
Atualizações de documentos com IA
As edições sugeridas vêm de um LLM que lê a mudança de código e a documentação ao redor como contexto. Ele redige um texto novo que combina com o que o código faz agora. Trate o resultado como um bom primeiro rascunho, não como uma resposta pronta. Você ainda vai querer um olho humano em tudo que é voltado ao usuário.
Suporte a vários idiomas
O Doctective lida com TypeScript, JavaScript, Python, Java, Go, Rust, SQL e mais. Do lado da documentação, ele lê Markdown, MDX, JSDoc e docstrings, então funciona na maioria dos stacks modernos sem migração de formato.
Integração com o GitHub
A configuração passa pelo GitHub App do Doctective. Você o autoriza, escolhe os repositórios a monitorar e ele começa a indexar. Não há pipeline de CI para ligar à mão, o que mantém a adoção leve para equipes que não querem mais um arquivo de configuração.
Prós e contras
Prós
- Pega documentação desatualizada dentro do pull request, enquanto a mudança ainda está fresca no contexto.
- Abre um PR complementar com edições sugeridas, então você revisa um rascunho em vez de escrever do zero.
- Suporta muitas linguagens e formatos de documento, incluindo Markdown, MDX, JSDoc e docstrings.
- Encaixa em um fluxo de revisão do GitHub já existente, então há pouco a aprender.
- Indexa código e documentação juntos, o que também revela lacunas onde a documentação está totalmente ausente.
Contras
- Não há plano gratuito. Todos os níveis são pagos, a partir de $9.99/mo, então você não pode testá-lo em um projeto de hobby sem gastar.
- É só para o GitHub. Equipes no GitLab, Bitbucket ou com instalação própria não podem usá-lo.
- As edições sugeridas por IA ainda precisam de revisão. Em mudanças de comportamento sutis, um parágrafo de documento gerado pode soar confiante e estar levemente errado.
- Os limites de repositórios e assentos pesam em equipes maiores. O plano Team limita a 10 repos e 10 assentos, e o preço do Enterprise não é publicado.
Perguntas frequentes
Ele monitora seus pull requests no GitHub, detecta quando uma mudança de código deixa a documentação existente desatualizada e abre um PR complementar com atualizações sugeridas para os documentos. Você revisa e mescla as que quiser.
Conteúdo relacionado
Explore ferramentas, skills e artigos relacionados a Doctective.
Alternativas a Doctective
Base Code
Base44 (Wix) · Programação · ProdutividadeO Base Code é um ambiente de desenvolvimento em nuvem compartilhado da Base44. O time descreve mudanças em um repositório do GitHub pelo chat, confere tudo na prévia e envia o resultado como pull request.
Google EmbeddingGemma 2
Google DeepMind · Escrita · Imagem · ProgramaçãoGoogle EmbeddingGemma 2 é um modelo aberto de 740 milhões de parâmetros que transforma texto, código, imagens, áudio e quadros de vídeo em vetores de um único espaço de 768 dimensões, rodando em celulares e notebooks.
GitGlow
GitGlow · Programação · ProdutividadeO GitGlow é um cliente Git de desktop que coloca seu código e as mudanças dos seus agentes de IA na mesma revisão, para você saber o que vai sair da máquina antes de publicar.