Purpose
Generate consolidated technical documentation for software systems composed of multiple repositories (frontend, backend, microservices, infra, docs, wikis) stored locally on a shared file system.
Assumptions
- All repositories (including Wikis) are already cloned locally.
- Multiple repositories can make up a single logical system.
- Wikis are typically git repositories with the suffix
.wiki. - Languages may include Java, Python, JavaScript.
- There are no rigid naming conventions.
- Execution is manual via an AI agent (VS Code, Copilot, Gemini CLI, etc).
Inputs
- ROOT_PATH: folder containing multiple systems.
- OUTPUT_PATH: destination for the generated documentation.
- TEMPLATES_PATH: templates for README, ARCHITECTURE, API, CODE_COMMENTS.
Processing Steps
1. Discover Systems
- Scan ROOT_PATH recursively.
- Detect git repositories (.git folders).
- Identify Wiki repositories (folder name ends with
.wiki). - Cluster repositories by proximity in the file system.
- Treat each group (code + wikis) as a single logical system.
2. Analyze Repositories
For each repository:
- Detect the type (code, docs or wiki).
- If it is Code:
- Detect language and framework (Spring, Django, Node, etc).
- Detect the service type (backend, frontend, microservice, infra).
- Extract: README, build files, manifests, API routes, entities, configs.
- If it is Wiki:
- Detect main pages (Home.md, index.md).
- Extract: infrastructure guides, setup tutorials, business processes (DoR/DoD) and links to external legislation or assets.
- If it is Docs:
- Detect static generators (MkDocs, Sphinx, etc).
- Extract: functional manuals and user guides.
3. Generate Documentation
Create for each system:
- SYSTEM_OVERVIEW.md (Consolidated overview including business and technology).
- ARCHITECTURE.md.
- REPOSITORY_MAP.md.
- DEPLOYMENT.md (Information merged from code manifests and wiki guides).
- PROCESSES_AND_GUIDELINES.md (Extracted from Wikis: DoR, DoD, contribution rules).
Create for each repository:
- README.generated.md.
- API.generated.md.
- CODE_STRUCTURE.md (for code repositories).
- WIKI_SUMMARY.md (for wiki repositories).
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
Execution
The agent receives the command: "Run skill document-multiple-repository on <ROOT_PATH>"
Constraints
- Do not execute code.
- Do not modify the original repositories.
- Documentation only.