← 返回 Skills 市场
dannyxyz22

Document Multiple Repository

作者 Daniel Lélis Baggio · GitHub ↗ · v0.1.0
cross-platform ✓ 安全检测通过
979
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install document-multiple-repository
功能描述
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.
使用说明 (SKILL.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 \x3CROOT_PATH>"

Restrições (Constraints)

  • Não executar código.
  • Não modificar os repositórios originais.
  • Apenas documentação.
安全使用建议
This skill appears coherent and does what it says: scan a user-specified folder of locally-cloned repositories and generate documentation. Before running it, explicitly choose a narrow ROOT_PATH (do not point it at / or your entire home directory) so it only examines intended projects. Expect it to read repository files including READMEs and config files—if those repos contain secrets (API keys, private certs, .env files), remove or move them before running or run the skill in an isolated environment. Confirm your agent enforces the 'Do not execute code' constraint and will not upload generated documentation to external services unless you instruct it to. If you need automatic redaction of secrets or PII, add that step to the workflow or pre-sanitize repositories. If you want extra assurance, test the skill on a copy of repositories that contains only non-sensitive data.
功能分析
Type: OpenClaw Skill Name: document-multiple-repository Version: 0.1.0 The skill's purpose is to generate consolidated technical documentation from local repositories, as clearly stated in `SKILL.md`. The `SKILL.md` explicitly restricts the AI agent from executing code or modifying original repositories. All code snippets and commands found within the `templates/*.md` files (e.g., `curl` commands, `npm install`, Python/JavaScript code examples) are presented as illustrative content for the *generated documentation* itself, not as instructions for the AI agent to execute. The file system access described (e.g., scanning `ROOT_PATH`, detecting `.git` folders, extracting content) is consistent with the benign goal of documentation generation. There is no evidence of malicious intent, data exfiltration, unauthorized execution, or prompt injection attempts against the agent.
能力评估
Purpose & Capability
The skill claims to generate consolidated documentation from multiple locally-cloned repositories and its instructions only require scanning a provided ROOT_PATH, detecting git repos and wikis, and producing files under OUTPUT_PATH. There are no unrelated environment variables, binaries, or install steps required, so the requested capabilities match the stated purpose.
Instruction Scope
SKILL.md directs the agent to recursively scan ROOT_PATH for .git directories, classify repos, and extract README, build files, manifests, API routes, wiki pages, etc. This is appropriate for repository documentation, but the instructions do not include explicit safeguards: they may read configuration files or secrets that happen to live in the repositories (e.g., .env, config, private keys) and do not specify redaction, size limits, or exclude binary files. The skill also states 'Do not execute code' and 'Do not modify the original repositories', which constrain behavior, but enforcement depends on the host agent.
Install Mechanism
This is an instruction-only skill with no install spec and no code files to execute. That is the lowest-risk install model: nothing is written to disk by the skill itself and no external downloads are requested.
Credentials
The skill declares no required environment variables, credentials, or config paths. That is proportionate to its purpose of reading local repositories. There are template examples that show API headers and tokens (placeholders), but the skill does not request those at runtime.
Persistence & Privilege
always:false and default model-invocation settings are used. The skill does not request persistent presence or elevated platform privileges, nor does it modify other skills or global agent settings according to the provided files.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install document-multiple-repository
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /document-multiple-repository 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v0.1.0
Initial release: generate consolidated technical documentation for multi-repository systems. - Detects and clusters local git repositories (including wikis) into logical systems. - Analyzes each repository to extract language, structure, API routes, manifests, and key documentation. - Generates comprehensive documentation: overviews, architecture, deployment, repo maps, and process guidelines per system and repository. - Outputs structured documentation folders without modifying source repositories. - Supports Java, Python, JavaScript; recognizes backend, frontend, microservices, infra, docs, and wikis.
元数据
Slug document-multiple-repository
版本 0.1.0
许可证
累计安装 0
当前安装数 0
历史版本数 1
常见问题

Document Multiple Repository 是什么?

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. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 979 次。

如何安装 Document Multiple Repository?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install document-multiple-repository」即可一键安装,无需额外配置。

Document Multiple Repository 是免费的吗?

是的,Document Multiple Repository 完全免费(开源免费),可自由下载、安装和使用。

Document Multiple Repository 支持哪些平台?

Document Multiple Repository 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 Document Multiple Repository?

由 Daniel Lélis Baggio(@dannyxyz22)开发并维护,当前版本 v0.1.0。

💬 留言讨论