Skill

Generate Comprehensive Wiki Documentation

Generates evidence-based technical wiki pages with code-traced citations and mandatory Mermaid diagrams.


72
Spark score
out of 100
Updated last month
Version 13.1.0

Add to Favorites

Why it matters

Automate the creation of in-depth technical documentation for software components, systems, and features. This skill generates structured Markdown pages with evidence-based depth, including diagrams and code path analysis.

Outcomes

What it gets done

01

Analyze code paths and dependencies to understand system behavior.

02

Generate structured Markdown documentation with diagrams and citations.

03

Ensure all claims are backed by specific code references.

04

Format documentation for compatibility with VitePress.

Install

Add it to your toolbox

Run in your project directory:

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

Overview

Wiki Page Writer

Generates comprehensive technical documentation pages with evidence-based depth: traced code paths, per-claim citations, mandatory Mermaid diagrams, and a fixed Overview-to-References structure. Use it when documenting a specific component, system, or feature, or generating a technical deep-dive with diagrams for a wiki catalogue.

What it does

Generates comprehensive technical documentation pages with evidence-based depth, under non-negotiable depth requirements: trace actual code paths rather than guessing from file names, cite a file path plus function or class name for every claim, explicitly distinguish fact (from reading code) from inference, explain why something exists before what it does, and never hand-wave with phrases like "this likely handles" - the source labels these five rules non-negotiable, applying to every page it generates rather than serving as optional, situational style guidance. Its procedure plans scope, audience, and documentation budget by file count, analyzes all relevant files for patterns, algorithms, dependencies, and data flow, writes structured Markdown with diagrams and citations, then validates that file paths exist, class names are accurate, and Mermaid renders correctly.

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

Every page requires VitePress frontmatter, a minimum of two Mermaid diagrams chosen from graph, sequenceDiagram, classDiagram, stateDiagram-v2, erDiagram, or flowchart as fits the content (using autonumber in sequence diagrams, mandatory dark-mode colors - node fills #2d333b, borders #6d5dfc, text #e6edf3, with subgraph backgrounds in #161b22 bordered #30363d and connecting lines in #8b949e, plus ,color:#e6edf3 on any inline style declaration - and no <br/> tags), and citations for every non-trivial claim in (file_path:line_number) format from at least five different source files, with (Unknown - verify in path/to/check) where evidence is missing. Its fixed structure runs Overview (explaining why) through Architecture, Components, Data Flow, Implementation, to References, using tables for APIs, configs, and component summaries, and pseudocode written in a familiar language for complex code paths. VitePress compatibility rules require escaping bare generics like `List`<T> `` outside code fences and using only 3- or 6-digit hex colors.

When to use - and when NOT to

Use it when a user asks to document a specific component, system, or feature, wants a technical deep-dive with diagrams, or a wiki catalogue section needs its content generated.

Inputs and outputs

Input: a codebase or component needing documentation. Output: a structured Markdown wiki page with VitePress frontmatter, at least two dark-mode-styled Mermaid diagrams, and citations from at least five source files, following the Overview-to-References structure.

Who it's for

Documentation engineers and agents generating technical wiki pages who need evidence-based, code-traced accuracy rather than plausible-sounding but unverified documentation.

Beyond API and config tables, it calls for a dedicated comparison table whenever a page introduces a new technology.

FAQ

Common questions

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.