MR
Mayur Rathi
@mayurrathi
⭐ 5 GitHub stars

Wiki Architect

Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or...

mkdir -p ./skills/wiki-architect && curl -sfL https://raw.githubusercontent.com/mayurrathi/awesome-agent-skills/main/skills/wiki-architect/SKILL.md -o ./skills/wiki-architect/SKILL.md

Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).

Skill Content

# 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


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.

🎯 Best For

  • Technical writers
  • API documentation teams
  • Developers scaffolding new projects
  • Prototype builders
  • UI designers

💡 Use Cases

  • Generating JSDoc/TSDoc comments
  • Writing README files for new projects
  • Bootstrapping React components
  • Creating API route handlers

📖 How to Use This Skill

  1. 1

    Install the Skill

    Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.

  2. 2

    Load into Your AI Assistant

    Open Claude and reference the skill. Paste the SKILL.md content or use the system prompt tab.

  3. 3

    Apply Wiki Architect to Your Work

    Provide context for your task — paste source material, describe your audience, or share existing work to guide the AI.

  4. 4

    Review and Refine

    Edit the AI output for accuracy, tone, and completeness. Add human insight where the AI lacks context.

❓ Frequently Asked Questions

Does it follow my documentation style?

Most documentation skills respect existing style. Provide a style guide or example in your prompt.

Can I customize the generated output?

Yes — modify the skill's prompt instructions to match your project conventions and coding style.

Does this work with Figma?

Some design skills integrate with Figma plugins. Check the Works With section for supported tools.

Can this connect to my database directly?

Most data skills accept CSV or JSON input. Database connectors are listed in the Works With section.

How do I install Wiki Architect?

Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/wiki-architect/SKILL.md, ready to use.

⚠️ Common Mistakes to Avoid

Auto-generating without reviewing

AI documentation can contain inaccuracies. Always verify technical accuracy.

Using generated code without understanding

Understand what generated code does before shipping it to production.

Skipping usability testing

AI-generated designs should be validated with real users before development.

Not validating data quality

AI analysis is only as good as your input data. Profile and clean data before analysis.

🔗 Related Skills