wiki-architect

You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.

38 stars

Best use case

wiki-architect is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.

Teams using wiki-architect should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/wiki-architect/SKILL.md --create-dirs "https://raw.githubusercontent.com/lingxling/awesome-skills-cn/main/antigravity-awesome-skills/plugins/antigravity-awesome-skills-claude/skills/wiki-architect/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/wiki-architect/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How wiki-architect Compares

Feature / Agentwiki-architectStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Wiki Architect

You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.

## When to Use
- 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

## Procedure

1. **Scan** the repository file tree and README
2. **Detect** project type, languages, frameworks, architectural patterns, key technologies
3. **Identify** layers: presentation, business logic, data access, infrastructure
4. **Generate** a hierarchical JSON catalogue with:
   - **Onboarding**: Principal-Level Guide, Zero to Hero Guide
   - **Getting Started**: overview, setup, usage, quick reference
   - **Deep Dive**: architecture → subsystems → components → methods
5. **Cite** real files in every section prompt using `file_path:line_number`

## Onboarding Guide Architecture

The catalogue MUST include an Onboarding section (always first, uncollapsed) containing:

1. **Principal-Level Guide** — For senior/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, strategic direction, "where to go deep" reading order

2. **Zero-to-Hero Learning Path** — For newcomers. 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

## 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.

## When to Use
This skill is applicable to execute the workflow or actions described in the overview.

Related Skills

wiki-vitepress

38
from lingxling/awesome-skills-cn

Transform generated wiki Markdown files into a polished VitePress static site with dark theme and interactive Mermaid diagrams. Use when user asks to "build a site" or "package as VitePress", user runs the /deep-wiki, or user wants a browsable HTML output from generated wiki pages.

wiki-researcher

38
from lingxling/awesome-skills-cn

You are an expert software engineer and systems analyst. Use when user asks "how does X work" with expectation of depth, user wants to understand a complex system spanning many files, or user asks for architectural analysis or pattern investigation.

wiki-qa

38
from lingxling/awesome-skills-cn

Answer repository questions grounded entirely in source code evidence. Use when user asks a question about the codebase, user wants to understand a specific file, function, or component, or user asks "how does X work" or "where is Y defined".

wiki-page-writer

38
from lingxling/awesome-skills-cn

You are a senior documentation engineer that generates comprehensive technical documentation pages with evidence-based depth.

wiki-onboarding

38
from lingxling/awesome-skills-cn

Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase. Use when user asks for onboarding docs or getting-started guides, user runs /deep-wiki, or user wants to help new team members understand a codebase.

wiki-changelog

38
from lingxling/awesome-skills-cn

Generate structured changelogs from git history. Use when user asks "what changed recently", "generate a changelog", "summarize commits" or user wants to understand recent development activity.

software-architecture

38
from lingxling/awesome-skills-cn

Guide for quality focused software architecture. This skill should be used when users want to write code, design architecture, analyze code, in any case that relates to software development.

social-proof-architect

38
from lingxling/awesome-skills-cn

One sentence - what this skill does and when to invoke it

site-architecture

38
from lingxling/awesome-skills-cn

Plan or restructure website hierarchy, navigation, URL patterns, breadcrumbs, and internal linking. Use when mapping pages, sections, and site structure, but not for XML sitemap auditing or schema markup.

seo-structure-architect

38
from lingxling/awesome-skills-cn

Analyzes and optimizes content structure including header hierarchy, suggests schema markup, and internal linking opportunities. Creates search-friendly content organization.

senior-architect

38
from lingxling/awesome-skills-cn

Complete toolkit for senior architect with modern tools and best practices.

robius-app-architecture

38
from lingxling/awesome-skills-cn

CRITICAL: Use for Robius app architecture patterns. Triggers on: Tokio, async, submit_async_request, 异步, 架构, SignalToUI, Cx::post_action, worker task, app structure, MatchEvent, handle_startup