wiki-page-writer
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 tech...
Best use case
wiki-page-writer is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
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 tech...
Teams using wiki-page-writer 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
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/wiki-page-writer/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How wiki-page-writer Compares
| Feature / Agent | wiki-page-writer | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
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 tech...
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 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 ## 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 2 per page** - Use `autonumber` in all `sequenceDiagram` blocks - Choose appropriate types: `graph`, `sequenceDiagram`, `classDiagram`, `stateDiagram-v2`, `erDiagram`, `flowchart` - **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) ### Citations - Every non-trivial claim needs `(file_path:line_number)` - Minimum 5 different source files cited per page - If evidence is missing: `(Unknown – verify in path/to/check)` ### Structure - Overview (explain WHY) → Architecture → Components → Data Flow → Implementation → References - Use Markdown tables for APIs, configs, and component summaries - Use comparison tables when introducing technologies - Include pseudocode in a familiar language when explaining complex code paths ### 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 ## When to Use This skill is applicable to execute the workflow or actions described in the overview.
Related Skills
Frontend Pages
Create or modify React pages using MUI components, React Router, and the HATEOAS API client.
wiki-qa
Answers questions about a code repository using source file analysis. Use when the user asks a question about how something works, wants to understand a component, or needs help navigating the code...
wiki-onboarding
Generates two complementary onboarding guides — a Principal-Level architectural deep-dive and a Zero-to-Hero contributor walkthrough. Use when the user wants onboarding documentation fo...
wiki-docs
Document custom Magento 2 site functionality in the project wiki. Systematically captures custom features, modules, configurations, and business logic for client handover and developer onboarding.
wiki-changelog
Analyzes git commit history and generates structured changelogs categorized by change type. Use when the user asks about recent changes, wants a changelog, or needs to understand what changed in th...
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...
technical-writer
Use for documentation tasks including API docs, user guides, JSDoc comments, grammar documentation, and README updates. Activate when writing or reviewing documentation, creating JSDoc, or updating examples. For public docs in /site, pair with site-maintainer.
operation-manual-writer
Create standardized business operation manuals, procedures, and documentation following corporate guidelines. Use this skill when the user needs to create or update business documents such as release procedures, work instructions, operation manuals, regulations, or standard operating procedures (SOPs). Triggers include requests like "業務マニュアル作成", "手順書を書いて", "operation manual", "create procedure document", or when standardized business documentation is needed.
deepwiki-mcp
DeepWiki MCP server for AI-powered GitHub repository documentation and
copywriter
Brand voice guardian and conversion-focused copywriter, specializing in direct, no-fluff copy that adapts to project's brand voice
claw-wiki
A knowledge base for the Generative Agents Town. Read and write articles to share knowledge.
article-writer
Edit and refine blog articles and technical posts to match a specific writing style. Use when editing markdown articles, blog posts, or technical writing. Applies conversational, direct, no-BS style with strict guidelines (no em dashes, no empty framing phrases). Best for technical content aimed at experienced developers.