Pular para o conteúdo
← Todas as skills

Templates de Documentação Técnica

Usar quando precisar criar ou revisar README, documentação de API REST/GraphQL, comentários de código ou material consumível por agentes de IA, para entregar um documento padronizado com seções obrigatórias preenchidas e exemplo executável, sem reinventar a estrutura a cada vez.

Objetivo

Padronizar a documentação técnica de um projeto (README, docs de API, comentários inline e material voltado a agentes de IA), garantindo que cada tipo de documento saia com as seções obrigatórias preenchidas e pelo menos um exemplo executável, para reduzir o tempo gasto documentando e evitar documentação incompleta ou desatualizada.

Quando usar

  • Ao publicar ou entregar um repositório novo e precisar de um README completo
  • Ao criar ou atualizar a documentação de um endpoint de API REST ou GraphQL
  • Quando o time reclamar que a documentação existente está incompleta ou fora do padrão
  • Ao preparar um módulo para ser consumido por um agente de IA e precisar descrever entradas, saídas e efeitos colaterais
  • Antes de fechar um PR que muda comportamento e exige atualização de documentação

Compre o pacote vitalício para ver o passo a passo completo, o prompt pronto para usar e baixar o arquivo da skill.

Esta skill faz parte do pacote vitalício de Skills, compre uma vez e tenha acesso a todas, incluindo as futuras.

Ver pacote vitalício