Skill

Generate Structured Wiki Documentation from Code

Generates structured wiki catalogues and onboarding guides from a codebase, with principal-level and zero-to-hero paths.


81
Spark score
out of 100
Updated today
Version 15.7.0

Add to Favorites

Why it matters

Automate the creation of comprehensive wiki documentation and onboarding guides directly from your codebase. This skill analyzes your project structure, identifies key components, and generates structured JSON output for clear project understanding.

Outcomes

What it gets done

01

Scan repository file tree and README for documentation generation.

02

Detect project type, languages, frameworks, and architectural patterns.

03

Generate hierarchical JSON catalogues including onboarding, getting started, and deep dive sections.

04

Cite specific files and line numbers within generated documentation prompts.

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/ag-wiki-architect | bash

Overview

Wiki Architect

Generates a structured wiki catalogue and onboarding guide from a codebase: a dense Principal-Level Guide for senior engineers and a progressive Zero-to-Hero path for newcomers, every section citing real files. Use when asked to create a wiki, document a repo, generate docs, or produce an onboarding/zero-to-hero guide for a codebase.

What it does

This skill acts as a documentation architect, producing structured wiki catalogues and onboarding guides directly from a codebase rather than generic templates. Its five-step procedure: scan the repository file tree and README, detect project type/languages/frameworks/architectural patterns, identify architectural layers (presentation, business logic, data access, infrastructure), generate a hierarchical JSON catalogue, and cite real files (file_path:line_number) in every section prompt rather than describing things abstractly.

The catalogue always opens, uncollapsed, with an Onboarding section built from two distinct guides: a Principal-Level Guide for senior/principal engineers - dense and opinionated, built around the single core architectural insight illustrated with pseudocode in a different language than the codebase's own, a system architecture Mermaid diagram, a domain model ER diagram, and an explicit "where to go deep" reading order with design tradeoffs; and a Zero-to-Hero Learning Path for newcomers, structured in progressive depth - Part I covers language/framework foundations with cross-language comparisons, Part II covers this specific codebase's architecture and domain model, Part III covers dev setup/testing/navigation/contributing, and appendices include a 40+ term glossary and key file reference. Beyond onboarding, the catalogue covers Getting Started (overview, setup, usage, quick reference) and a Deep Dive drilling from architecture down through subsystems, components, and methods.

Language detection picks a deliberately different comparison language to anchor the Principal Guide's pseudocode - C#/Java/Go/TypeScript codebases get compared against Python, Python codebases against JavaScript, and Rust against C++ or Go - forcing the explanation to surface what's actually distinctive about the codebase's own language choices rather than restating them in isolation. Structural constraints keep the catalogue navigable: maximum nesting depth of 4 levels, maximum 8 children per section, and small repositories (10 files or fewer) get only the Getting Started section, skipping Deep Dive, while still including the onboarding guides. Every title must derive from actual repository content - generic placeholder section names are explicitly disallowed.

When to use - and when NOT to

Use this skill when a user asks to create a wiki, document a repo, generate documentation, understand a project's structure or architecture, get a table of contents or documentation plan, or wants an onboarding/"zero to hero" guide for a codebase.

It is specifically a codebase-documentation generator - its output is a structured catalogue with concrete file citations, not a general-purpose writing or explanation task disconnected from an actual repository to scan.

Inputs and outputs

Input is a repository - its file tree, README, and source files - to document. Output is a JSON code block following the catalogue schema (items[].children[] nodes each with title, name, prompt, and children) containing the Onboarding section (Principal-Level Guide plus Zero-to-Hero path), Getting Started, and, for larger repos, a Deep Dive drilling into architecture, subsystems, components, and methods, with every prompt citing specific file_path:line_number references.

Integrations

Produces Mermaid diagrams (system architecture) and ER diagrams (domain model) as part of the Principal-Level Guide, and adapts its comparison-language pseudocode based on the detected primary language of the target repository.

Who it's for

Teams wanting a generated wiki or onboarding guide for a codebase - serving both principal-level engineers needing a dense architectural summary and newcomers needing a progressive learning path - grounded in the actual repository content rather than generic documentation boilerplate.

FAQ

Common questions

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.