document-multiple-repository
Gera documentação técnica consolidada para sistemas de software com múltiplos repositórios (frontend, backend.
Setup & Installation
Install command
clawhub install dannyxyz22/document-multiple-repositoryIf the CLI is not installed:
Install command
npx clawhub@latest install dannyxyz22/document-multiple-repositoryOr install with OpenClaw CLI:
Install command
openclaw skills install dannyxyz22/document-multiple-repositoryor paste the repo link into your assistant's chat
Install command
https://github.com/openclaw/skills/tree/main/skills/dannyxyz22/document-multiple-repositoryWhat This Skill Does
Generates consolidated technical documentation for software systems spread across multiple repositories, including frontends, backends, microservices, and wikis stored locally. It discovers git repos, clusters them into logical systems, and produces structured markdown docs covering architecture, APIs, deployment, and processes.
Instead of manually piecing together docs from each repo, the skill scans and clusters all repos at once and outputs a consistent documentation structure in a single pass.
When to Use It
- Documenting a microservices platform cloned from multiple GitHub repos
- Creating an architecture overview before onboarding a new engineer
- Mapping all repos in a monorepo-adjacent folder structure
- Extracting deployment steps from scattered wikis and manifests
- Generating API docs from routes across frontend and backend repos
View original SKILL.md file
# 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 <ROOT_PATH>"
## Restrições (Constraints)
- Não executar código.
- Não modificar os repositórios originais.
- Apenas documentação.Example Workflow
Here's how your AI assistant might use this skill in practice.
User asks: Documenting a microservices platform cloned from multiple GitHub repos
- 1Documenting a microservices platform cloned from multiple GitHub repos
- 2Creating an architecture overview before onboarding a new engineer
- 3Mapping all repos in a monorepo-adjacent folder structure
- 4Extracting deployment steps from scattered wikis and manifests
- 5Generating API docs from routes across frontend and backend repos
Gera documentação técnica consolidada para sistemas de software com múltiplos repositórios (frontend, backend.
Security Audits
These signals reflect official OpenClaw status values. A Suspicious status means the skill should be used with extra caution.