document-multiple-repository
为具有多个存储库(前端、后端、微服务、wiki)的软件系统生成综合技术文档。当用户请求多存储库文档、整合架构视图、存储库映射或来自多个本地存储库的文档时使用。
安装 / 下载方式
TotalClaw CLI推荐
totalclaw skills install shop:totalclaw:totalclaw~dannyxyz22-document-multiple-repositorycURL直接下载,无需登录
curl -fsSL https://skills.taituai.com/api/skills/totalclaw%3Atotalclaw~dannyxyz22-document-multiple-repository/file -o dannyxyz22-document-multiple-repository.md# 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.
---
## 中文说明
# 技能:document-multiple-repository
## 目的
为由多个存储库(前端、后端、微服务、基础设施、文档、wiki)组成、并存储在共享文件系统本地的软件系统生成整合的技术文档。
## 前提假设
- 所有存储库(包括 Wiki)均已克隆到本地。
- 多个存储库可以组成一个单一的逻辑系统。
- Wiki 通常是带有 `.wiki` 后缀的 git 存储库。
- 涉及的语言可能包括 Java、Python、JavaScript。
- 不存在严格的命名约定。
- 通过 AI 代理(VS Code、Copilot、Gemini CLI 等)手动执行。
## 输入(Inputs)
- ROOT_PATH:包含多个系统的文件夹。
- OUTPUT_PATH:生成文档的输出目标位置。
- TEMPLATES_PATH:用于 README、ARCHITECTURE、API、CODE_COMMENTS 的模板。
## 处理步骤
### 1. 发现系统(Discover Systems)
- 递归扫描 ROOT_PATH。
- 检测 git 存储库(.git 文件夹)。
- 识别 Wiki 存储库(文件夹名称以 `.wiki` 结尾)。
- 按文件系统中的邻近程度对存储库进行聚类分组。
- 将每个分组(代码 + wiki)视为一个单一的逻辑系统。
### 2. 分析存储库(Analyze Repositories)
对每个存储库:
- 检测类型(code、docs 或 wiki)。
- 如果是 Code(代码):
- 检测语言和框架(Spring、Django、Node 等)。
- 检测服务类型(backend、frontend、microservice、infra)。
- 提取:README、构建文件、清单、API 路由、实体、配置。
- 如果是 Wiki:
- 检测主要页面(Home.md、index.md)。
- 提取:基础设施指南、安装教程、业务流程(DoR/DoD)以及指向外部法规或资源的链接。
- 如果是 Docs:
- 检测静态生成器(MkDocs、Sphinx 等)。
- 提取:功能手册和用户指南。
### 3. 生成文档(Generate Documentation)
为每个系统创建:
- SYSTEM_OVERVIEW.md(涵盖业务与技术的整合视图)。
- ARCHITECTURE.md。
- REPOSITORY_MAP.md。
- DEPLOYMENT.md(合并自代码清单和 wiki 指南的信息)。
- PROCESSES_AND_GUIDELINES.md(从 Wiki 中提取:DoR、DoD、贡献规则)。
为每个存储库创建:
- README.generated.md。
- API.generated.md。
- CODE_STRUCTURE.md(用于代码存储库)。
- WIKI_SUMMARY.md(用于 wiki 存储库)。
### 4. 输出结构(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
## 执行
代理接收命令:
"Run skill document-multiple-repository on <ROOT_PATH>"
## 限制(Constraints)
- 不执行代码。
- 不修改原始存储库。
- 仅生成文档。