Refatorização da Documentação
InicianteGrátis2 minatualizado 2026-10-21
Detalhes
name | doc-refactor |
|---|---|
description | Reestruturar a documentação do projeto para maior clareza e acessibilidade |
Refatore a estrutura da documentação do projeto, adaptando-a ao tipo de projeto:
- Analise o projeto: Identifique o tipo (biblioteca/API/aplicação web/CLI/microsserviços), a arquitetura e as personas de utilizadores
- Centralize a documentação: Mova a documentação técnica para
docs/com referências cruzadas adequadas - README.md na raiz: Simplifique-o como ponto de entrada com visão geral, início rápido, resumo de módulos/componentes, licença e contactos
- Documentação de componentes: Adicione ficheiros README ao nível de módulo/pacote/serviço com instruções de configuração e de teste
- Organize
docs/por categorias relevantes:
- Arquitetura, Referência da API, Base de Dados, Design, Resolução de Problemas, Implementação, Contribuições (adapte às necessidades do projeto)
- Crie guias (selecione os aplicáveis):
- Guia do Utilizador: Documentação para o utilizador final de aplicações
- Documentação da API: Endpoints, autenticação e exemplos para APIs
- Guia de Desenvolvimento: Configuração, testes e fluxo de trabalho de contribuição
- Guia de Implementação: Implementação em produção para serviços/aplicações
- Use Mermaid para todos os diagramas (arquitetura, fluxos, esquemas)
Mantenha a documentação concisa, de leitura rápida e contextualizada para o tipo de projeto.
Última Atualização: 4 de agosto de 2026
Versão do Claude Code: 2.1.220
Fontes:
- https://code.claude.com/docs/en/commands
Modelos Compatíveis: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5
Componentes para esta tarefa
Escolhemos à mão os agentes, skills e comandos que resolvem este tipo de trabalho: Agentes e skills para documentação técnica.
Guia da comunidade open-source (MIT) · tradução e manutenção Doutor AI.
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.
Poupe horas todas as semanas com IA, sem complicações
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.