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 technical deep-dives, or documenting specific components or systems.
Best use case
wiki-page-writer is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. 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.
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.
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "wiki-page-writer" skill to help with this workflow task. Context: 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.
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
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 technical deep-dives, or documenting specific components or systems.
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.
Related Guides
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
Related Skills
prd-doc-writer
Write and iteratively refine PRD/需求文档 with a story-driven structure and strict staged confirmations (journey map alignment, per-story single-point confirmation, final generation gate). Use when the user asks to 梳理/撰写/完善 PRD、需求文档、用户故事、验收标准，并希望用 ASCII 线框图与 Mermaid（流程图/状态图/时序图）来减少歧义、共同完成文档。
svelte-code-writer
CLI tools for Svelte 5 documentation lookup and code analysis. MUST be used whenever creating, editing or analyzing any Svelte component (.svelte) or Svelte module (.svelte.ts/.svelte.js). If possible, this skill should be executed within the svelte-file-editor agent for optimal results.
writer
Document creation, format conversion (ODT/DOCX/PDF), mail merge, and automation with LibreOffice Writer.
wiki-vitepress
Packages generated wiki Markdown into a VitePress static site with dark theme, dark-mode Mermaid diagrams with click-to-zoom, and production build output. Use when the user wants to create a browsable website from generated wiki pages.
wiki-researcher
Conducts multi-turn iterative deep research on specific topics within a codebase with zero tolerance for shallow analysis. Use when the user wants an in-depth investigation, needs to understand how something works across multiple files, or asks for comprehensive analysis of a specific system or pattern.
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 codebase.
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 for a codebase.
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 the repository.
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 understand a project's architecture at a high level.
seo-content-writer
Writes SEO-optimized content based on provided keywords and topic briefs. Creates engaging, comprehensive content following best practices. Use PROACTIVELY for content creation tasks.
pagerduty-automation
Automate PagerDuty tasks via Rube MCP (Composio): manage incidents, services, schedules, escalation policies, and on-call rotations. Always search tools first for current schemas.
lark-wiki
飞书知识库：管理知识空间和文档节点。创建和查询知识空间、管理节点层级结构、在知识库中组织文档和快捷方式。当用户需要在知识库中查找或创建文档、浏览知识空间结构、移动或复制节点时使用。