READMEs, docs de API, ADRs, diagramas e changelogs que não envelhecem
A documentação técnica costuma ser a primeira coisa a ficar para trás. O código muda todas as semanas, o README continua a descrever a instalação de há um ano e a especificação da API vive num documento que ninguém abre desde a última migração. O custo aparece tarde: cada pessoa nova perde dias a perceber o que já estava decidido, e ninguém se lembra do porquê.
Os componentes desta página tratam a documentação como resultado de um processo e não como tarefa manual adiada. Geram referências de API a partir do código, escrevem Registos de Decisão de Arquitetura (ADR) com contexto e alternativas, desenham diagramas em Mermaid ou no modelo C4, montam o changelog a partir do histórico de commits e verificam se os ficheiros existentes ainda correspondem ao que está implementado.
Comece pelo que dói mais no seu projeto. Se ninguém consegue arrancar o ambiente local, o README e o guia de entrada valem mais do que qualquer diagrama. Se a equipa de frontend pergunta sempre o formato das respostas, comece pela documentação da API. Os agentes servem para trabalho aberto e continuado, os comandos para uma tarefa concreta e repetida, as skills para fixar formatos e regras de escrita.
21 componentes escolhidos à mão, de 4 ângulos diferentes.
O ponto de partida de qualquer repositório: explicar o que o projeto faz, como se arranca e como se contribui. Inclui também o trabalho menos visível de manter esses ficheiros vivos à medida que o código muda.
Serve para quando existe código a mais e texto a menos: cria e melhora a documentação do projeto a partir do próprio código, aplicando normas de escrita técnica consistentes.
Use este agente para criar, melhorar e manter a documentação do projeto. Especializado em escrita técnica, normas de documentação e geração de documen
Pensado para bases de código herdadas. Analisa a arquitetura e os padrões de implementação já existentes e produz manuais técnicos longos, em vez de páginas soltas.
Cria documentação técnica abrangente a partir de bases de código existentes. Analisa a arquitetura, padrões de design e detalhes de implementação para
Um comando único para a passagem de sincronização, que atualiza o estado de implementação, as alterações de API e o conteúdo desalinhado depois de uma ronda de desenvolvimento.
Atualizar sistematicamente a documentação do projeto com o estado da implementação, alterações de API e conteúdo sincronizado
Útil quando a documentação já é grande demais para reler à mão, porque monta validação e atualizações automáticas para apanhar páginas que deixaram de bater certo.
Usar PROATIVAMENTE para implementar sistemas de manutenção de documentação abrangentes com garantia de qualidade, validação e atualizações automáticas
Nem todos os READMEs servem o mesmo público. Esta skill dá modelos consoante o tipo de projeto e quem o vai ler, de biblioteca interna a projeto aberto.
Use ao escrever ou melhorar ficheiros README. Nem todos os READMEs são iguais - fornece templates e orientação adequados ao seu público-alvo e tipo de
Para equipas que querem deixar de discutir estrutura. Reúne modelos de README, de documentação de API e de comentários de código, incluindo formatos pensados para leitura por IA.
Templates de documentação e diretrizes de estrutura. README, docs de API, comentários de código e documentação amigável para IA.
Documentação que outras pessoas leem para integrar com o seu sistema. Cobre especificações OpenAPI, listagens completas de parâmetros e a passagem de contexto entre backend e frontend.
Cobre o ciclo completo de uma API exposta a terceiros: escrita da especificação OpenAPI, portais de documentação interativos e exemplos de código prontos para quem integra.
Use este agente ao criar ou melhorar documentação de API, escrever especificações OpenAPI, construir portais de documentação interativa ou gerar exemp
Quando a API já está estável e falta apenas a referência, gera a documentação em vários formatos de saída e trata da publicação automática.
Gerar automaticamente documentação de referência de API com múltiplos formatos de saída e deployment automatizado
Indicada para quem trabalha em design-first ou precisa de gerar SDKs, porque cria e mantém especificações OpenAPI 3.1 e verifica a conformidade do contrato.
Gera e mantém especificações OpenAPI 3.1 a partir de código, especificações orientadas ao design e padrões de validação. Utiliza ao criar documentação
Resolve o momento em que o backend termina e o frontend fica à espera de saber o que existe, produzindo um documento de entrega focado em quem consome os endpoints.
Criar documentação de handoff de API para programadores frontend. Usar quando o trabalho de backend estiver concluído e precisar de ser documentado pa
Para os casos em que faltam as listagens completas. Produz referências exaustivas de parâmetros e guias de configuração, em vez de meia dúzia de exemplos ilustrativos.
Cria referências técnicas exaustivas e documentação de API. Gera listas abrangentes de parâmetros, guias de configuração e materiais de referência pes
Documentação para quem chega e pergunta porque é que o sistema está feito assim. Junta o desenho geral, as decisões registadas por escrito e as representações visuais.
Um arranque completo quando não existe nada escrito sobre o desenho do sistema, já que produz de uma vez os diagramas, os ADRs e uma visualização navegável.
Gerar documentação de arquitetura abrangente com diagramas, ADRs e visualização interativa
Para fixar decisões antes de se perderem no histórico de conversas. Escreve Registos de Decisão de Arquitetura estruturados, com o contexto e as alternativas ponderadas.
Agente especialista para criar Registos de Decisão Arquitetural (ADRs) abrangentes com formatação estruturada otimizada para consumo de IA e legibilid
Segue o modelo C4 e gera os níveis de contexto, contentor e componente em Mermaid, o que ajuda quando é preciso explicar o mesmo sistema a públicos com detalhe diferente.
Gere documentação de arquitetura usando diagramas Mermaid do modelo C4. Use quando lhe for pedido para criar diagramas de arquitetura, documentar a ar
Quando o diagrama tem de caber num formato específico, produz ASCII, Mermaid, PlantUML ou Draw.io, incluindo ERDs, máquinas de estados e grafos de dependências.
Criar diagramas técnicos em múltiplos formatos (ASCII, Mermaid, PlantUML, Draw.io). Usa PROATIVAMENTE para visualização de arquitetura, geração de ERD
Referência de sintaxe para quem escreve os diagramas à mão dentro do Markdown, com cobertura de diagramas de classes, de sequência e de modelação de domínio.
Guia abrangente para criar diagramas de software usando a sintaxe Mermaid. Usar quando os utilizadores precisam de criar, visualizar ou documentar sof
O que mudou desde a última versão e o que alguém precisa de saber no primeiro dia. São dois problemas com a mesma raiz: contexto que só existe na cabeça de quem já lá está.
Trabalha a partir do histórico de git para produzir changelogs e notas de lançamento, e mantém a documentação de versões alinhada de versão para versão.
Especialista em changelogs e release notes. Use PROATIVAMENTE para gerar changelogs a partir do histórico do git, criar release notes e manter a docum
Para quem só quer o ficheiro CHANGELOG.md em ordem. Gera e mantém as entradas no formato Keep a Changelog, sem inventar estrutura nova a cada versão.
Gerar e manter o changelog do projeto com o formato Keep a Changelog
Separa dois públicos que costumam ficar misturados: a partir dos commits recentes produz uma nota virada para o cliente e outra nota técnica para a equipa.
Gerar documentação abrangente de lançamento a partir dos commits recentes, produzindo dois resultados distintos: uma nota de lançamento voltada para o
Gera o guia de entrada com preparação de ambiente, fluxos de trabalho e tutoriais, o que poupa repetir as mesmas explicações a cada pessoa que chega.
Criar um guia abrangente de onboarding para programadores com configuração de ambiente, fluxos de trabalho e tutoriais interativos
Transforma código existente em tutoriais passo a passo com exemplos práticos, útil quando a referência já está escrita mas ninguém percebe por onde começar.
Cria tutoriais passo a passo e conteúdo educativo a partir de código. Transforma conceitos complexos em experiências de aprendizagem progressiva com e
Cada item da biblioteca técnica do Doutor AI é um ficheiro de texto. Os agentes ficam em .claude/agents/, os comandos em .claude/commands/ e as skills em .claude/skills/, dentro do repositório onde os quer usar. Se preferir tê-los disponíveis em todos os projetos, coloque-os na pasta equivalente dentro de ~/.claude/. Depois de gravar o ficheiro, reinicie a sessão do Claude Code para que o novo componente seja lido. Os agentes são escolhidos pela descrição, por isso basta pedir a tarefa por palavras; os comandos chamam-se pelo nome, precedido de barra; as skills carregam quando o pedido corresponde ao que a descrição indica. Instale dois ou três de cada vez, não vinte.
Estes componentes rendem mais encadeados do que isolados. Uma sequência que funciona bem num projeto já em curso: primeiro um agente que lê a base de código e produz o desenho geral, depois os ADRs para registar as decisões que só existem na memória da equipa e, no fim, o README e o guia de entrada, que assentam nessa base. A documentação de API segue outro ritmo, ligado ao ciclo de desenvolvimento: gere a especificação OpenAPI a partir do código e volte a gerá-la sempre que um endpoint mude. O changelog fecha o ciclo, porque nasce dos commits e serve de registo do que foi entregue em cada versão.
Nenhum destes componentes sabe aquilo que não está escrito em lado nenhum. Um agente lê o código, os commits e os ficheiros existentes; não sabe porque é que a equipa rejeitou a alternativa óbvia há dois anos, nem que aquele serviço vai ser desligado no trimestre seguinte. Esse contexto tem de vir de si. Há ainda um risco conhecido: documentação gerada em grande volume dá a sensação de trabalho feito e passa a ser aceite sem leitura. Reveja o que sai antes de gravar, sobretudo nos ADRs e na documentação de API, onde um detalhe errado leva outra pessoa a construir sobre uma premissa falsa.
Depende do que pede. A documentação de referência, ou seja, listas de endpoints, parâmetros e opções de configuração, sai bem porque a informação já está no código. O texto que explica intenção e compromissos precisa de contexto que só a equipa tem. Na prática, gere a parte mecânica e escreva à mão as três ou quatro páginas que explicam decisões.
Rever diffs, apanhar bugs antes do merge e reduzir dívida técnica.
React, Vue, Angular, design systems, acessibilidade e desempenho no browser.
Componentes para escrever, correr e avaliar testes com o Claude Code.
Prompts e recursos curados de fontes internacionais, normalizados e categorizados: mais de 11 mil. Um robô do Doutor AI verifica as fontes todos os dias e traz o que há de novo.
Precisa de uma solução à medida?
Não sabe por onde começar a usar IA no seu negócio? Receba uma avaliação gratuita e um plano à medida - sem compromisso.
O Doutor AI dá-lhe 1859 prompts de IA prontos a copiar, por indústria e em português simples - mais uma biblioteca técnica completa para quem quer ir mais longe.
