HomeCasa Prompts

Perceber um código desconhecido: mapa de arquitetura e guia de onboarding

Transforme a árvore e os ficheiros principais de um repositório num mapa claro: arquitetura, percurso de um pedido, glossário, zonas de risco e por onde começar na sua tarefa concreta. Pensado para ChatGPT, Claude, Gemini e Microsoft Copilot. Inclui 4 variáveis personalizáveis e pode copiá-lo gratuitamente com um clique.

Intermédio · Texto · Pendente de revisão editorial

Pensado para:

Prompt

Atua como engenheiro sénior que ajuda uma pessoa recém-chegada a perceber um repositório que não conhece.

Contexto:
- Projeto e stack: {{projeto}}
- Árvore de pastas e ficheiros principais (README, configuração, ponto de entrada, rotas, modelos): {{ficheiros}}
- A minha tarefa concreta neste código: {{tarefa}}
- A minha experiência com esta stack: {{experiencia}}

Entregáveis:
1. Resumo em 5 linhas: o que faz o sistema, para quem e quais são as peças principais.
2. Mapa de arquitetura: camadas ou módulos, responsabilidade de cada pasta importante e como comunicam, com um diagrama Mermaid.
3. Percurso de um pedido ou fluxo típico do início ao fim, citando ficheiros e funções reais que apareçam no que te dei.
4. Glossário dos termos de negócio e do projeto presentes no código.
5. Para a minha tarefa: os ficheiros que provavelmente terei de alterar, por que ordem os ler e que testes correr.
6. Zonas de risco: acoplamento forte, «magia» do framework, configuração por ambiente, efeitos secundários escondidos.
7. Dez perguntas concretas para fazer à equipa.

Restrições:
- Baseia-te apenas no que te dei. Se deduzires algo sem o ver, marca como [VERIFICAR]; se faltar um ficheiro essencial, diz-me qual e porquê.
- Não inventes nomes de ficheiros, funções nem comandos.
- Ajusta o nível de detalhe à minha experiência: {{experiencia}}.
- Se a informação não chegar para o mapa, pede-me primeiro os ficheiros em falta.

Formato: secções numeradas, diagrama Mermaid e listas curtas.

Como utilizar

Gera a árvore com tree -L 3 -I node_modules ou git ls-files e cola também o README, o ficheiro de configuração principal e o ponto de entrada. Se o contexto for grande, partilha o repositório por partes e pede o mapa no fim.

Exemplo de utilização

Projeto: API de reservas em NestJS com PostgreSQL · Tarefa: adicionar reembolsos parciais ao módulo de pagamentos · Experiência: conheço Node.js mas não NestJS.

Exemplo de resultado

Partindo do princípio de que a árvore de pastas que colaste segue a estrutura padrão do Symfony 6…

1. Resumo

Loja online B2C: catálogo, carrinho, checkout e encomendas. Controladores em src/Controller, lógica em src/Service, persistência com Doctrine sobre MySQL e vistas em Twig.

2. Mapa da arquitetura

flowchart LR
  R[config/routes] --> C[src/Controller]
  C --> S[src/Service]
  S --> E[src/Entity + Repository]
  E --> DB[(MySQL)]
  C --> T[templates/ Twig]

5. Para a tua tarefa: envio por peso

Ordem de leitura recomendada:

  1. src/Entity/ShippingMethod.php [VERIFICAR] — como estão modelados os métodos atuais.
  2. O serviço que calcula o custo do envio, provavelmente em src/Service/Shipping/ [VERIFICAR].
  3. src/Entity/Product.php — já existe um campo de peso? Se não, vais precisar de uma migração Doctrine.
  4. O template do checkout em templates/checkout/ [VERIFICAR].

Testes a correr: no mínimo php bin/phpunit tests/Service.

6. Zonas de risco

  • Listeners de eventos do Doctrine ou do kernel que alteram a encomenda sem aparecerem no controlador.
  • Configuração diferente por ambiente em config/packages/{dev,prod}.

7. Perguntas para a equipa

  1. O peso é guardado em gramas ou em quilos?
  2. As tarifas por peso mudam consoante o país de destino?…

Dados-chave

Categoria
Programação e desenvolvimento · Documentação
Tipo de resultado
Texto
Nível
Intermédio
Pensado para
ChatGPT, Claude, Gemini e Microsoft Copilot
Verificado em
Pendente de verificação editorial
Variáveis
Projeto e stack, Árvore e ficheiros principais, A minha tarefa e Experiência com a stack
Idioma
Português
Preço
Gratuito, sem registo
Atualizado
07/11/2026

Perguntas frequentes

Quanto código tenho de colar?

Começa pela árvore de pastas, README, configuração e ponto de entrada. Assim o modelo pode pedir-te os ficheiros concretos de que precisa em vez de processar o repositório inteiro.

Posso confiar no diagrama?

É um ponto de partida. Confirma o que estiver marcado como [VERIFICAR] no código ou com a equipa antes de tomar decisões de design.

Para que serve este prompt?

Transforme a árvore e os ficheiros principais de um repositório num mapa claro: arquitetura, percurso de um pedido, glossário, zonas de risco e por onde começar na sua tarefa concreta.

Com que ferramentas de IA funciona?

Foi pensado para ChatGPT, Claude, Gemini e Microsoft Copilot. Ainda não o verificámos nestas ferramentas, pelo que os resultados podem variar entre elas.

Como personalizo o prompt?

Clique em “Personalizar” e preencha as variáveis (Projeto e stack, Árvore e ficheiros principais, A minha tarefa e Experiência com a stack). O texto atualiza-se instantaneamente e pode depois copiá-lo com um clique. Os valores ficam guardados apenas no seu navegador.

Preciso de experiência para o utilizar?

É de nível intermédio: convém conhecer o tema para fornecer bom contexto e rever o resultado com sentido crítico.

Este prompt é gratuito?

Sim. Todos os prompts do HomeCasa Prompts são gratuitos, sem registo nem subscrição. Pode também utilizá-los em projetos profissionais.

Posso confiar no resultado da IA?

Trate-o como um rascunho de qualidade: verifique sempre os dados, os números e as afirmações importantes antes de publicar ou tomar decisões.

Prompts relacionados