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
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.
page-cro
When the user wants to optimize, improve, or increase conversions on any marketing page — including homepage, landing pages, pricing pages, feature pages, or blog posts. Also use when the user says "CRO," "conversion rate optimization," "this page isn't converting," "improve conversions," or "why isn't this page working." For signup/registration flows, see signup-flow-cro. For post-signup activation, see onboarding-cro. For forms outside of signup, see form-cro. For popups/modals, see popup-cro.
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 browsa...
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...
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-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
Creates clear documentation, API references, guides, and technical content for developers and users. Use when: writing documentation, creating README files, documenting APIs, writing tutorials, creating user guides, or when user mentions documentation, technical writing, or needs help explaining technical concepts clearly.
writer
Document creation, format conversion (ODT/DOCX/PDF), mail merge, and automation with LibreOffice Writer.
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.
firecrawl
Official Firecrawl CLI skill for web scraping, search, crawling, and browser automation. Returns clean LLM-optimized markdown. USE FOR: - Web search and research - Scraping pages, docs, and articles - Site mapping and bulk content extraction - Browser automation for interactive pages Must be pre-installed and authenticated. See rules/install.md for setup, rules/security.md for output handling.