Skip to content

ARCAlhau80/ISGT

Repository files navigation

🚀 IA Squad Framework — Template Genérico

O que é: Kit de Engenharia de IA para padronizar desenvolvimento assistido por Copilot/Claude/ChatGPT.
Uso: Copie a pasta template/ para dentro do seu projeto e preencha os [PLACEHOLDERS].


⚡ Quick Start (5 minutos)

Para projeto NOVO:

# 1. Copie tudo para seu projeto
cp -r template/.github   meu-projeto/.github
cp -r template/patterns  meu-projeto/patterns   # opcional
cp -r template/skills    meu-projeto/skills      # opcional
cp -r template/prompts   meu-projeto/prompts     # opcional
cp -r template/docs      meu-projeto/docs        # opcional

# 2. Busque e substitua os placeholders
# Abra os arquivos e substitua:
#   [PROJECT_NAME]     → Nome do seu projeto
#   [PROJECT_DESC]     → Descrição curta (1 linha)
#   [LANGUAGE]         → Java, TypeScript, Python, C#, etc.
#   [FRAMEWORK]        → Spring Boot, React, FastAPI, .NET, etc.
#   [BUILD_CMD]        → ./mvnw clean install, npm run build, etc.
#   [RUN_CMD]          → java -jar app.jar, npm start, etc.
#   [TEST_CMD]         → ./mvnw test, npm test, pytest, etc.
#   [DB_TYPE]          → PostgreSQL, MySQL, MongoDB, Oracle, etc.
#   [PACKAGE_BASE]     → br.com.empresa.projeto, src/, etc.

# 3. Pronto! Abra no VS Code e o Copilot já lê as instruções.

Para projeto EXISTENTE:

# 1. Copie apenas o .github (mínimo obrigatório)
cp -r template/.github   meu-projeto-existente/.github

# 2. Preencha o AS-IS.md com o estado atual do projeto
# 3. Adapte o copilot-instructions.md para a realidade do código
# 4. Copie patterns/ e skills/ conforme necessário

📁 Estrutura

template/
├── .github/
│   ├── copilot-instructions.md      ← Lido automaticamente pelo Copilot
│   ├── copilot/                     ← Contexto técnico do projeto
│   │   ├── project-context.md       ← O que o projeto faz
│   │   ├── coding-standards.md      ← Padrões de código
│   │   ├── domains-rules.md         ← Regras de negócio críticas
│   │   └── tech-stack.md            ← Dependências e versões
│   ├── context/                     ← Análise estratégica
│   │   ├── AS-IS.md                 ← Estado atual (dívidas, problemas)
│   │   └── TO-BE.md                 ← Visão futura (roadmap)
│   └── agents/                      ← Agentes IA especializados
│       ├── AGENTS.md                ← Índice e workflows
│       ├── ARCHITECT.md             ← Design review
│       ├── BACKEND.md               ← Geração de código
│       ├── QA.md                    ← Testes e qualidade
│       ├── REFACTOR.md              ← Limpeza de código
│       ├── COORDINATOR.md           ← Planejamento
│       └── OBSERVABILITY.md         ← Logs, métricas, tracing
├── docs/                            ← Documentação técnica
│   ├── architecture/
│   │   └── overview.md              ← Visão geral da arquitetura
│   ├── legacy-analysis/
│   │   └── overview.md              ← Mapa de débito técnico
│   └── decisions/
│       └── README.md                ← ADRs (Architecture Decision Records)
├── patterns/                        ← Templates de design patterns
│   ├── README.md                    ← Guia de uso
│   ├── controller-pattern.md        ← REST/API handlers
│   ├── service-pattern.md           ← Lógica de negócio
│   ├── repository-pattern.md        ← Acesso a dados
│   ├── entity-pattern.md            ← Modelos de domínio
│   ├── dto-pattern.md               ← Data transfer objects
│   ├── visitor-pattern.md           ← Percorrer estruturas
│   └── _example-pattern.md          ← Exemplo para copiar
├── skills/                          ← How-to guides técnicos
│   ├── README.md                    ← Guia de uso
│   ├── testing-strategies.md        ← Pirâmide de testes
│   ├── clean-architecture.md        ← Separação de camadas
│   ├── observability.md             ← Logs, métricas, tracing
│   ├── security-basics.md           ← OWASP Top 10
│   ├── api-design.md                ← REST best practices
│   ├── performance-tuning.md        ← Otimização
│   ├── domain-driven-design.md      ← DDD essentials
│   ├── ci-cd.md                     ← Pipeline & Docker
│   └── _example-skill.md            ← Exemplo para copiar
├── prompts/                         ← Prompts prontos para IA
│   ├── README.md                    ← Guia de uso
│   ├── code-generation.md           ← Gerar componentes
│   ├── testing.md                   ← Gerar testes
│   ├── refactoring.md               ← Refatorar código
│   ├── documentation.md             ← Gerar docs/ADRs
│   ├── observability.md             ← Instrumentar código
│   └── _example-prompt.md           ← Exemplo para copiar
└── README.md                        ← Este arquivo

📋 Checklist de Configuração

Mínimo Obrigatório (funciona em 5 min)

  • Preencher copilot-instructions.md com nome, stack e regras
  • Preencher project-context.md com o que o projeto faz
  • Preencher coding-standards.md com 3-5 padrões principais

Recomendado (20-30 min)

  • Preencher tech-stack.md com dependências e versões
  • Preencher domains-rules.md com regras que não podem ser quebradas
  • Criar 1-2 patterns para os tipos de classe mais criados

Completo (1-2 horas)

  • Preencher AS-IS.md (projetos existentes)
  • Preencher TO-BE.md (roadmap)
  • Configurar agents relevantes
  • Criar skills específicas do projeto
  • Criar prompts prontos para tarefas comuns

❓ FAQ

P: Preciso copiar TUDO?
R: Não. O mínimo é o .github/copilot-instructions.md. O resto é opcional e incremental.

P: Funciona com qualquer linguagem?
R: Sim. Os templates são agnósticos. Adapte os exemplos para sua stack.

P: O Copilot lê esses arquivos automaticamente?
R: O copilot-instructions.md sim (automático). Os outros, o Copilot consulta quando relevante ou quando você referencia.

P: Posso usar com Claude/ChatGPT fora do VS Code?
R: Sim. Copie o conteúdo dos arquivos como contexto na conversa.

P: Como atualizo quando o template mestre evolui?
R: Compare manualmente e incorpore melhorias. Cada projeto é independente.

About

IA Squad Generic Template (ADK) — Kit de Engenharia de IA para padronizar desenvolvimento assistido por GitHub Copilot, Claude e ChatGPT. Inclui agentes especializados (Architect, Backend, QA, Refactor, Coordinator, Observability), patterns, skills, prompts e estrutura de documentação pronta para uso em qualquer projeto.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors