| name | wiki-architect |
| description | "Design — Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when" |
Wiki Architect
You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.
When to Activate
- User asks to "create a wiki", "document this repo", "generate docs"
- User wants to understand project structure or architecture
- User asks for a table of contents or documentation plan
- User asks for an onboarding guide or "zero to hero" path
Source Repository Resolution (MUST DO FIRST)
Before any analysis, you MUST determine the source repository context:
- Check for git remote: Run
git remote get-url origin to detect if a remote exists
- Ask the user: "Is this a local-only repository, or do you have a source repository URL (e.g., GitHub, Azure DevOps)?"
- Remote URL provided → store as
REPO_URL, use linked citations: [file:line](REPO_URL/blob/BRANCH/file#Lline)
- Local-only → use local citations:
(file_path:line_number)
- Determine default branch: Run
git rev-parse --abbrev-ref HEAD
- Do NOT proceed until source repo context is resolved
Procedure
- Resolve source repo (see above — MUST be first)
- Scan the repository file tree and README
- Detect project type, languages, frameworks, architectural patterns, key technologies
- Identify layers: presentation, business logic, data access, infrastructure
- Generate a hierarchical JSON catalogue with:
- Onboarding: Contributor Guide, Staff Engineer Guide, Executive Guide, Product Manager Guide (in
onboarding/ folder)
- Getting Started: overview, setup, usage, quick reference
- Deep Dive: architecture → subsystems → components → methods
- Cite real files in every section prompt using linked or local citation format
Onboarding Guide Architecture
The catalogue MUST include an Onboarding section (always first, uncollapsed) containing:
-
Contributor Guide — For new contributors (assumes Python/JS). Progressive depth:
- Part I: Language/framework/technology foundations with cross-language comparisons
- Part II: This codebase's architecture and domain model
- Part III: Dev setup, testing, codebase navigation, contributing
- Appendices: 40+ term glossary, key file reference
-
Staff Engineer Guide — For staff/principal ICs. Dense, opinionated. Includes:
- The ONE core architectural insight with pseudocode in a different language
- System architecture Mermaid diagram, domain model ER diagram
- Design tradeoffs, decision log, dependency rationale, "where to go deep" reading order
-
Executive Guide — For VP/director-level leaders. NO code snippets. Includes:
- Capability map, risk assessment, technology investment thesis
- Cost/scaling model, dependency map, actionable recommendations
-
Product Manager Guide — For PMs. ZERO engineering jargon. Includes:
- User journey maps, feature capability map, known limitations
- Data/privacy overview, configuration/feature flags, FAQ
Language Detection
Detect primary language from file extensions and build files, then select a comparison language:
- C#/Java/Go/TypeScript → Python as comparison
- Python → JavaScript as comparison
- Rust → C++ or Go as comparison
Constraints
- Max nesting depth: 4 levels
- Max 8 children per section
- Small repos (≤10 files): Getting Started only (skip Deep Dive, still include onboarding)
- Every prompt must reference specific files
- Derive all titles from actual repository content — never use generic placeholders
Output
JSON code block following the catalogue schema with items[].children[] structure, where each node has title, name, prompt, and children fields.
Diff History
- v00.33.0: Ingested from skills-main
Why This Skill Exists
Design — Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when
When to Use
Use this skill when the task requires wiki architect capabilities.
What If Fails
- condition: Assets visuais não disponíveis para análise
