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.
- License 许可
- MIT
- 最近更新
- 2026-11-11
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- 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.
03 SKILL.md 正文
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)
- TRACE ACTUAL CODE PATHS — Do not guess from file names. Read the implementation.
- EVERY CLAIM NEEDS A SOURCE — File path + function/class name.
- DISTINGUISH FACT FROM INFERENCE — If you read the code, say so. If inferring, mark it.
- FIRST PRINCIPLES — Explain WHY something exists before WHAT it does.
- NO HAND-WAVING — Don't say "this likely handles..." — read the code.
Procedure
- Plan: Determine scope, audience, and documentation budget based on file count
- Analyze: Read all relevant files; identify patterns, algorithms, dependencies, data flow
- Write: Generate structured Markdown with diagrams and citations
- 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
autonumberin allsequenceDiagramblocks - 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 bareList<T> - No
<br/>in Mermaid blocks - All hex colors must be 3 or 6 digits
04 同仓库更多 Skills
web-performance-optimization
Optimize website and web application performance including loading speed, Core Web Vitals, bundle size, caching strategies, and runtime performance
web-design-guidelines
Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
wcag-audit-patterns
Conduct WCAG 2.2 accessibility audits with automated testing, manual verification, and remediation guidance. Use when auditing websites for accessibility, fixing WCAG violations, or implementing accessible design patterns.
ui-ux-pro-max
UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 9 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind, shadcn/ui). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient. Integrations: shadcn/ui MCP for component search and examples.
stitch-ui-design
Expert guide for creating effective prompts for Google Stitch AI UI design tool. Use when user wants to design UI/UX in Stitch, create app interfaces, generate mobile/web designs, or needs help crafting Stitch prompts. Covers prompt structure, specificity techniques, iteration strategies, and design-to-code workflows for Stitch by Google.
scroll-experience
Expert in building immersive scroll-driven experiences - parallax storytelling, scroll animations, interactive narratives, and cinematic web experiences. Like NY Times interactives, Apple product pages, and award-winning web experiences. Makes websites feel like experiences, not just pages. Use when: scroll animation, parallax, scroll storytelling, interactive story, cinematic website.