Index of every page on this site: llms.txt
All skills
microsoft avatar

/wiki-architect

@0d60658
by microsoftmicrosoft/skills3.2k stars
373
Run it yourself

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 understand a project's architecture at a high level.

Use this Skill: https://skilld.dev/gh/microsoft/skills/wiki-architect

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈67 tokens for metadata: the name and description. ≈928 when used: this file.

Description uses 3.3% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈267 characters, or 3.3%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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:

  1. Check for git remote: Run git remote get-url origin to detect if a remote exists
  2. 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)
  3. Determine default branch: Run git rev-parse --abbrev-ref HEAD
  4. Do NOT proceed until source repo context is resolved

Procedure

  1. Resolve source repo (see above — MUST be first)
  2. Scan the repository file tree and README
  3. Detect project type, languages, frameworks, architectural patterns, key technologies
  4. Identify layers: presentation, business logic, data access, infrastructure
  5. 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
  6. 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:

  1. 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
  2. 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
  3. 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
  4. 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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo4 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill is a documentation tool from Microsoft designed to analyze codebases and generate structured wiki content. It uses standard git commands to resolve repository information and performs local file analysis to map project architecture. No security issues were detected.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer9mo

    2/2 files flagged

Signed by skilld at 0d60658. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 8 months ago
metadata
{
  "author": "Microsoft",
  "version": "1.0.0"
}

README badge

README badge for microsoft/skills/wiki-architect