Skill: document-multiple-repository
Propósito
Gerar documentação técnica consolidada para sistemas de software compostos por múltiplos repositórios
(frontend, backend, microservices, infra, docs, wikis) armazenados localmente em um sistema de arquivos compartilhado.
Premissas
- Todos os repositórios (incluindo Wikis) já estão clonados localmente.
- Múltiplos repositórios podem compor um único sistema lógico.
- Wikis são tipicamente repositórios git com o sufixo
.wiki.
- As linguagens podem incluir Java, Python, JavaScript.
- Não existem convenções rígidas de nomenclatura.
- A execução é manual via agente de IA (VS Code, Copilot, Gemini CLI, etc).
Entradas (Inputs)
- ROOT_PATH: pasta contendo múltiplos sistemas.
- OUTPUT_PATH: destino para a documentação gerada.
- TEMPLATES_PATH: templates para README, ARCHITECTURE, API, CODE_COMMENTS.
Etapas de Processamento
1. Descoberta de Sistemas (Discover Systems)
- Escanear ROOT_PATH recursivamente.
- Detectar repositórios git (pastas .git).
- Identificar repositórios de Wiki (nome da pasta termina com
.wiki).
- Agrupar (cluster) repositórios por proximidade no sistema de arquivos.
- Tratar cada grupo (código + wikis) como um único sistema lógico.
2. Análise de Repositórios (Analyze Repositories)
Para cada repositório:
- Detectar o tipo (code, docs ou wiki).
- Se for Code (Código):
- Detectar linguagem e framework (Spring, Django, Node, etc).
- Detectar o tipo de serviço (backend, frontend, microservice, infra).
- Extrair: README, build files, manifests, API routes, entities, configs.
- Se for Wiki:
- Detectar páginas principais (Home.md, index.md).
- Extrair: guias de infraestrutura, tutoriais de setup, processos de negócio (DoR/DoD) e links para legislação externa ou ativos.
- Se for Docs:
- Detectar geradores estáticos (MkDocs, Sphinx, etc).
- Extrair: manuais funcionais e guias de usuário.
3. Geração de Documentação (Generate Documentation)
Criar para cada sistema:
- SYSTEM_OVERVIEW.md (Visão consolidada incluindo negócio e tecnologia).
- ARCHITECTURE.md.
- REPOSITORY_MAP.md.
- DEPLOYMENT.md (Informações mescladas de manifests de código e guias de wiki).
- PROCESSES_AND_GUIDELINES.md (Extraído de Wikis: DoR, DoD, regras de contribuição).
Criar para cada repositório:
- README.generated.md.
- API.generated.md.
- CODE_STRUCTURE.md (para repositórios de código).
- WIKI_SUMMARY.md (para repositórios de wiki).
4. Estrutura de Saída (Output Structure)
OUTPUT_PATH/
system-name/
SYSTEM_OVERVIEW.md
ARCHITECTURE.md
REPOSITORY_MAP.md
DEPLOYMENT.md
PROCESSES_AND_GUIDELINES.md
repos/
repo-name/
README.generated.md
API.generated.md
CODE_STRUCTURE.md
WIKI_SUMMARY.md
Execução
O agente recebe o comando:
"Run skill document-multiple-repository on "
Restrições (Constraints)
- Não executar código.
- Não modificar os repositórios originais.
- Apenas documentação.
1---2name: document-multiple-repository3description: Gera documentação técnica consolidada para sistemas de software com múltiplos repositórios (frontend, backend, microservices, wikis). Use quando o usuário pedir documentação de multi-repo, visão de arquitetura consolidada, mapeamento de repositórios ou documentação a partir de vários repos locais.4---56# Skill: document-multiple-repository78## Propósito9Gerar documentação técnica consolidada para sistemas de software compostos por múltiplos repositórios10(frontend, backend, microservices, infra, docs, wikis) armazenados localmente em um sistema de arquivos compartilhado.1112## Premissas13- Todos os repositórios (incluindo Wikis) já estão clonados localmente.14- Múltiplos repositórios podem compor um único sistema lógico.15- Wikis são tipicamente repositórios git com o sufixo `.wiki`.16- As linguagens podem incluir Java, Python, JavaScript.17- Não existem convenções rígidas de nomenclatura.18- A execução é manual via agente de IA (VS Code, Copilot, Gemini CLI, etc).1920## Entradas (Inputs)21- ROOT_PATH: pasta contendo múltiplos sistemas.22- OUTPUT_PATH: destino para a documentação gerada.23- TEMPLATES_PATH: templates para README, ARCHITECTURE, API, CODE_COMMENTS.2425## Etapas de Processamento2627### 1. Descoberta de Sistemas (Discover Systems)28- Escanear ROOT_PATH recursivamente.29- Detectar repositórios git (pastas .git).30- Identificar repositórios de Wiki (nome da pasta termina com `.wiki`).31- Agrupar (cluster) repositórios por proximidade no sistema de arquivos.32- Tratar cada grupo (código + wikis) como um único sistema lógico.3334### 2. Análise de Repositórios (Analyze Repositories)35Para cada repositório:36- Detectar o tipo (code, docs ou wiki).37- Se for Code (Código):38 - Detectar linguagem e framework (Spring, Django, Node, etc).39 - Detectar o tipo de serviço (backend, frontend, microservice, infra).40 - Extrair: README, build files, manifests, API routes, entities, configs.41- Se for Wiki:42 - Detectar páginas principais (Home.md, index.md).43 - Extrair: guias de infraestrutura, tutoriais de setup, processos de negócio (DoR/DoD) e links para legislação externa ou ativos.44- Se for Docs:45 - Detectar geradores estáticos (MkDocs, Sphinx, etc).46 - Extrair: manuais funcionais e guias de usuário.4748### 3. Geração de Documentação (Generate Documentation)49Criar para cada sistema:50- SYSTEM_OVERVIEW.md (Visão consolidada incluindo negócio e tecnologia).51- ARCHITECTURE.md.52- REPOSITORY_MAP.md.53- DEPLOYMENT.md (Informações mescladas de manifests de código e guias de wiki).54- PROCESSES_AND_GUIDELINES.md (Extraído de Wikis: DoR, DoD, regras de contribuição).5556Criar para cada repositório:57- README.generated.md.58- API.generated.md.59- CODE_STRUCTURE.md (para repositórios de código).60- WIKI_SUMMARY.md (para repositórios de wiki).6162### 4. Estrutura de Saída (Output Structure)63OUTPUT_PATH/64 system-name/65 SYSTEM_OVERVIEW.md66 ARCHITECTURE.md67 REPOSITORY_MAP.md68 DEPLOYMENT.md69 PROCESSES_AND_GUIDELINES.md70 repos/71 repo-name/72 README.generated.md73 API.generated.md74 CODE_STRUCTURE.md75 WIKI_SUMMARY.md7677## Execução78O agente recebe o comando:79"Run skill document-multiple-repository on <ROOT_PATH>"8081## Restrições (Constraints)82- Não executar código.83- Não modificar os repositórios originais.84- Apenas documentação.
dvcrn