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)
- - ROOTPATH: pasta contendo múltiplos sistemas.
- OUTPUTPATH: destino para a documentação gerada.
- TEMPLATESPATH: templates para README, ARCHITECTURE, API, CODECOMMENTS.
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.
- 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.
- 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:
- - SYSTEMOVERVIEW.md (Visão consolidada incluindo negócio e tecnologia).
- ARCHITECTURE.md.
- REPOSITORYMAP.md.
- DEPLOYMENT.md (Informações mescladas de manifests de código e guias de wiki).
- PROCESSESANDGUIDELINES.md (Extraído de Wikis: DoR, DoD, regras de contribuição).
Criar para cada repositório:
- - README.generated.md.
- API.generated.md.
- CODESTRUCTURE.md (para repositórios de código).
- WIKISUMMARY.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
ANDGUIDELINES.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.
技能：多仓库文档生成
目的
为存储在共享文件系统中的多个本地仓库（前端、后端、微服务、基础设施、文档、维基）组成的软件系统生成统一的技术文档。
前提条件
- - 所有仓库（包括维基）均已克隆到本地。
- 多个仓库可组成一个逻辑系统。
- 维基通常是后缀为 .wiki 的 Git 仓库。
- 语言可能包括 Java、Python、JavaScript。
- 不存在严格的命名约定。
- 通过 AI 代理（VS Code、Copilot、Gemini CLI 等）手动执行。
输入
- - ROOTPATH：包含多个系统的文件夹。
- OUTPUTPATH：生成文档的目标路径。
- TEMPLATESPATH：README、ARCHITECTURE、API、CODECOMMENTS 的模板。
处理步骤
1. 系统发现
- - 递归扫描 ROOT_PATH。
- 检测 Git 仓库（.git 文件夹）。
- 识别维基仓库（文件夹名称以 .wiki 结尾）。
- 根据文件系统中的邻近程度对仓库进行分组（聚类）。
- 将每个组（代码 + 维基）视为一个逻辑系统。
2. 仓库分析
对每个仓库：
- 检测语言和框架（Spring、Django、Node 等）。
- 检测服务类型（后端、前端、微服务、基础设施）。
- 提取：README、构建文件、清单、API 路由、实体、配置。
- 检测主页面（Home.md、index.md）。
- 提取：基础设施指南、设置教程、业务流程（DoR/DoD）以及外部法规或资产链接。
- 检测静态生成器（MkDocs、Sphinx 等）。
- 提取：功能手册和用户指南。
3. 文档生成
为每个系统创建：
- - SYSTEMOVERVIEW.md（包含业务和技术的统一视图）。
- ARCHITECTURE.md。
- REPOSITORYMAP.md。
- DEPLOYMENT.md（合并自代码清单和维基指南的信息）。
- PROCESSESANDGUIDELINES.md（从维基提取：DoR、DoD、贡献规则）。
为每个仓库创建：
- - README.generated.md。
- API.generated.md。
- CODESTRUCTURE.md（针对代码仓库）。
- WIKISUMMARY.md（针对维基仓库）。
4. 输出结构
OUTPUT_PATH/
system-name/
SYSTEM_OVERVIEW.md
ARCHITECTURE.md
REPOSITORY_MAP.md
DEPLOYMENT.md
PROCESSES
ANDGUIDELINES.md
repos/
repo-name/
README.generated.md
API.generated.md
CODE_STRUCTURE.md
WIKI_SUMMARY.md
执行
代理接收命令：
在
上运行技能 document-multiple-repository
约束条件
