SkillAgentSearch skills...

wiki-page-writer

Generates rich technical documentation pages with dark-mode Mermaid diagrams, source code citations, and first-principles depth

Install / Use

npx skills add microsoft/skills --skill wiki-page-writer

Installs into whichever agent you are using.

About this skill
📄

SKILL.md

Installable skill definition

Quality Score

87/100

Supported Platforms

Universal

Our assessment of wiki-page-writer

wiki-page-writer scores 87/100 on our quality scale, 639th of 1,153 Content & Media skills we index.

Its SKILL.md is 5.7 KB long, well organised into 12 sections with 1 code example: a solid amount of guidance for an agent.

With 3,051 GitHub stars, it is one of the more widely adopted skills in the catalogue.

Substance
26/30
Structure
17/20
Description
15/15
Adoption
15/20
Freshness
15/15

Maintenance, license and trust

  • The repository was last updated about 2 months ago, so wiki-page-writer is actively maintained.
  • Our last check on 2026-11-02 found the source still online.
  • It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
  • Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.

Safety scan

No issues found

Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.

AI review by kimi-k2.7-code on 2026-10-02. Automated pattern scan on 2026-10-02. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.

wiki-page-writer compared with similar skills

All 4 of these similar skills score higher than wiki-page-writer; compare them before choosing.

SkillScoreStarsUpdatedFormat
wiki-page-writer (this skill)by microsoft873.1k54d agoSKILL.md
siyuanby siyuan-note10047.3ktodayMCP Server
x402by browser-use100121.0k3d agoSKILL.md
algorithmic-artby anthropics100177.9k55d agoSKILL.md
pptxby anthropics100177.9k55d agoSKILL.md

Frequently asked questions

How do I install wiki-page-writer?
Run npx skills add microsoft/skills --skill wiki-page-writer. The install tabs above show the steps for each supported agent.
Which AI agents does wiki-page-writer work with?
It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
Is wiki-page-writer safe to use?
Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
Is wiki-page-writer still maintained?
The repository was last updated about 2 months ago, so wiki-page-writer is actively maintained.

name: wiki-page-writer description: Generates rich technical documentation pages with dark-mode Mermaid diagrams, source code citations, and first-principles depth. Use when writing documentation, generating wiki pages, creating technical deep-dives, or documenting specific components or systems. license: MIT metadata: author: Microsoft version: "1.0.0"

Wiki Page Writer

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

When to Activate

  • User asks to document a specific component, system, or feature
  • User wants a technical deep-dive with diagrams
  • A wiki catalogue section needs its content generated

Source Repository Resolution (MUST DO FIRST)

Before generating any page, 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

Depth Requirements (NON-NEGOTIABLE)

  1. TRACE ACTUAL CODE PATHS — Do not guess from file names. Read the implementation.
  2. EVERY CLAIM NEEDS A SOURCE — File path + function/class name.
  3. DISTINGUISH FACT FROM INFERENCE — If you read the code, say so. If inferring, mark it.
  4. FIRST PRINCIPLES — Explain WHY something exists before WHAT it does.
  5. NO HAND-WAVING — Don't say "this likely handles..." — read the code.

Procedure

  1. Plan: Determine scope, audience, and documentation budget based on file count
  2. Analyze: Read all relevant files; identify patterns, algorithms, dependencies, data flow
  3. Write: Generate structured Markdown with diagrams and citations
  4. Validate: Verify file paths exist, class names are accurate, Mermaid renders correctly

Mandatory Requirements

VitePress Frontmatter

Every page must have:

---
title: "Page Title"
description: "One-line description"
---

Mermaid Diagrams

  • Minimum 3–5 per page (scaled by scope: small=3, medium=4, large=5+)
  • Use at least 2 different diagram types — don't repeat the same type. Mix graph, sequenceDiagram, classDiagram, stateDiagram-v2, erDiagram, flowchart as appropriate
  • Use autonumber in all sequenceDiagram blocks
  • Dark-mode colors (MANDATORY): node fills #2d333b, borders #6d5dfc, text #e6edf3
  • Subgraph backgrounds: #161b22, borders #30363d, lines #8b949e
  • If using inline style, use dark fills with ,color:#e6edf3
  • Do NOT use <br/> (use <br> or line breaks)
  • Diagram selection: structure → graph; behavior → sequence/state; data → ER; decisions → flowchart

Citations

  • Every non-trivial claim needs a citation with the resolved format:
    • Remote repo: [src/path/file.ts:42](REPO_URL/blob/BRANCH/src/path/file.ts#L42)
    • Local repo: (src/path/file.ts:42)
    • Line ranges: [src/path/file.ts:42-58](REPO_URL/blob/BRANCH/src/path/file.ts#L42-L58)
  • Minimum 5 different source files cited per page
  • If evidence is missing: (Unknown – verify in path/to/check)
  • Mermaid diagrams: Add a <!-- Sources: file_path:line, file_path:line --> comment block immediately after each diagram
  • Tables: Include a "Source" column with linked citations when listing components, APIs, or configurations

Structure

  • Overview (explain WHY) → Architecture → Components → Data Flow → Implementation → References → Related Pages
  • Use tables aggressively — prefer tables over prose for any structured information (APIs, configs, components, comparisons)
  • Summary tables first: Start each major section with an at-a-glance summary table before details
  • Use comparison tables when introducing technologies or patterns — always compare side-by-side
  • Include a "Source" column with linked citations in tables listing code artifacts
  • Use bold for key terms, inline code for identifiers and paths
  • Include pseudocode in a familiar language when explaining complex code paths
  • Progressive disclosure: Start with the big picture, then drill into specifics — don't front-load details

Cross-References Between Wiki Pages

  • Inline links: When mentioning a concept, component, or pattern covered on another wiki page, link to it inline using relative Markdown links: [Component Name](../NN-section/page-name.md) or [Section Title](../NN-section/page-name.md#heading-anchor)
  • Related Pages section: End every page with a "Related Pages" section listing connected wiki pages:
    ## Related Pages
    
    | Page | Relationship |
    |------|-------------|
    | [Authentication](../02-architecture/authentication.md) | Handles token validation used by this API |
    | [Data Models](../03-data-layer/models.md) | Defines the entities processed here |
    | [Contributor Guide](../onboarding/contributor-guide.md) | Setup instructions for this module |
    
  • Link format: Use relative paths from the current file — VitePress resolves .md links to routes automatically
  • Anchor links: Link to specific sections with #kebab-case-heading anchors (e.g., [error handling](../02-architecture/overview.md#error-handling))
  • Bidirectional where possible: If page A links to page B, page B should link back to page A

VitePress Compatibility

  • Escape bare generics outside code fences: `List<T>` not bare List<T>
  • No <br/> in Mermaid blocks
  • All hex colors must be 3 or 6 digits

Related Skills

View on GitHub
GitHub Stars3.1k
CategoryContent
Updated1mo ago
Forks349

Languages

TypeScript

Trust signals

100/100

From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.

No cautions