Pular para o conteúdo
Skillpedia
Documentação40 mil · #4998

architecture-blueprint-generator

Gera um plano detalhado da arquitetura de um projeto de software. Analisa o código para criar diagramas, documentar padrões e manter a consistência do projeto.

O que ela faz

Este gerador cria um documento detalhado sobre a arquitetura de um projeto de software. Ele analisa o código para entender como o projeto está organizado, quais tecnologias usa e quais padrões de design foram aplicados.

Quando usar

  • ✓Ao iniciar um novo projeto para definir sua estrutura.
  • ✓Ao receber um projeto existente para entender sua arquitetura.
  • ✓Ao documentar a estrutura de um projeto para a equipe.

Exemplo do que pedir para a IA

“Gere um blueprint de arquitetura para este projeto Node.js, focando em microserviços e com diagramas C4.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/github/awesome-copilot/blob/main/skills/architecture-blueprint-generator/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/github/awesome-copilot/blob/main/skills/architecture-blueprint-generator/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

A IA examina os arquivos do seu projeto, identifica as tecnologias e padrões de arquitetura usados e gera um documento com descrições e diagramas visuais.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add github/awesome-copilot --skill architecture-blueprint-generator

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/architecture-blueprint-generator/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Gerador Abrangente de Projeto de Arquitetura

Variáveis de Configuração

${PROJECT_TYPE="Auto-detect|.NET|Java|React|Angular|Python|Node.js|Flutter|Outro"} <!-- Tecnologia principal --> ${ARCHITECTURE_PATTERN="Auto-detect|Clean Architecture|Microservices|Layered|MVVM|MVC|Hexagonal|Event-Driven|Serverless|Monolithic|Outro"} <!-- Padrão arquitetural principal --> ${DIAGRAM_TYPE="C4|UML|Flow|Component|None"} <!-- Tipo de diagrama de arquitetura --> ${DETAIL_LEVEL="High-level|Detailed|Comprehensive|Implementation-Ready"} <!-- Nível de detalhe a incluir --> ${INCLUDES_CODE_EXAMPLES=true|false} <!-- Incluir exemplos de código para ilustrar padrões --> ${INCLUDES_IMPLEMENTATION_PATTERNS=true|false} <!-- Incluir padrões de implementação detalhados --> ${INCLUDES_DECISION_RECORDS=true|false} <!-- Incluir registros de decisões arquiteturais --> ${FOCUS_ON_EXTENSIBILITY=true|false} <!-- Enfatizar pontos de extensão e padrões -->

Prompt Gerado

"Crie um documento abrangente 'Project_Architecture_Blueprint.md' que analise profundamente os padrões arquiteturais na base de código para servir como uma referência definitiva na manutenção da consistência arquitetural. Use a seguinte abordagem:

1. Detecção e Análise de Arquitetura

  • ${PROJECT_TYPE == "Auto-detect" ? "Analise a estrutura do projeto para identificar todas as pilhas de tecnologia e frameworks em uso, examinando:

    • Arquivos de projeto e configuração
    • Dependências de pacotes e instruções de importação
    • Padrões e convenções específicos de frameworks
    • Configurações de build e implantação" : "Concentre-se nos padrões e práticas específicos de ${PROJECT_TYPE}"}
  • ${ARCHITECTURE_PATTERN == "Auto-detect" ? "Determine o(s) padrão(ões) arquitetural(is) analisando:

    • Organização de pastas e namespaces
    • Fluxo de dependência e limites de componentes
    • Segregação de interfaces e padrões de abstração
    • Mecanismos de comunicação entre componentes" : "Documente como a arquitetura ${ARCHITECTURE_PATTERN} é implementada"}

2. Visão Geral da Arquitetura

  • Forneça uma explicação clara e concisa da abordagem arquitetural geral
  • Documente os princípios orientadores evidentes nas escolhas arquiteturais
  • Identifique os limites arquiteturais e como eles são impostos
  • Observe quaisquer padrões arquiteturais híbridos ou adaptações de padrões padrão

3. Visualização da Arquitetura

${DIAGRAM_TYPE != "None" ? `Crie diagramas ${DIAGRAM_TYPE} em múltiplos níveis de abstração:

  • Visão geral arquitetural de alto nível mostrando os principais subsistemas
  • Diagramas de interação de componentes mostrando relacionamentos e dependências
  • Diagramas de fluxo de dados mostrando como a informação se move pelo sistema
  • Garanta que os diagramas reflitam com precisão a implementação real, não padrões teóricos` : "Descreva os relacionamentos dos componentes com base nas dependências reais do código, fornecendo explicações textuais claras de:
  • Organização e limites dos subsistemas
  • Direções de dependência e interações de componentes
  • Fluxo de dados e sequências de processos"}

4. Componentes Arquiteturais Principais

Para cada componente arquitetural descoberto na base de código:

  • Propósito e Responsabilidade:

    • Função principal dentro da arquitetura
    • Domínios de negócios ou preocupações técnicas abordadas
    • Limites e escopo
  • Estrutura Interna:

    • Organização de classes/módulos dentro do componente
    • Principais abstrações e suas implementações
    • Padrões de design utilizados
  • Padrões de Interação:

    • Como o componente se comunica com outros
    • Interfaces expostas e consumidas
    • Padrões de injeção de dependência
    • Mecanismos de publicação/assinatura de eventos
  • Padrões de Evolução:

    • Como o componente pode ser estendido
    • Pontos de variação e mecanismos de plugin
    • Abordagens de configuração e personalização

5. Camadas Arquiteturais e Dependências

  • Mapeie a estrutura de camadas conforme implementada na base de código
  • Documente as regras de dependência entre as camadas
  • Identifique mecanismos de abstração que permitem a separação de camadas
  • Observe quaisquer dependências circulares ou violações de camadas
  • Documente os padrões de injeção de dependência usados para manter a separação

6. Arquitetura de Dados

  • Documente a estrutura e organização do modelo de domínio
  • Mapeie relacionamentos de entidades e padrões de agregação
  • Identifique padrões de acesso a dados (repositórios, mappers de dados, etc.)
  • Documente abordagens de transformação e mapeamento de dados
  • Observe estratégias e implementações de cache
  • Documente padrões de validação de dados

7. Implementação de Preocupações Transversais (Cross-Cutting Concerns)

Documente os padrões de implementação para preocupações transversais:

…

Perguntas frequentes

O que é um 'blueprint de arquitetura'?

É um documento que descreve como um software é construído, incluindo suas partes, como elas se conectam e as decisões importantes tomadas durante o design.

A IA pode detectar automaticamente as tecnologias usadas?

Sim, se você não especificar, a IA tentará identificar as tecnologias e padrões de arquitetura por conta própria, analisando a estrutura do código.

Que tipos de diagramas posso obter?

Você pode solicitar diagramas como C4, UML, Fluxo ou Componente, ou optar por não ter diagramas e receber apenas descrições textuais.

Detalhes

Descrição original do autor

Comprehensive project architecture blueprint generator that analyzes codebases to create detailed architectural documentation. Automatically detects technology stacks and architectural patterns, generates visual diagrams, documents implementation patterns, and provides extensible blueprints for maintaining architectural consistency and guiding new development.

repo: github/awesome-copilot

Popularidade

Estrelas no GitHub
40 mil
Posição no ranking
#4998
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas