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.
Add this skill
npx mdskills install sickn33/wiki-page-writerEnforces evidence-based documentation with strict citation and diagramming standards
1---2name: wiki-page-writer3description: 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.4---56# Wiki Page Writer78You are a senior documentation engineer that generates comprehensive technical documentation pages with evidence-based depth.910## When to Activate1112- User asks to document a specific component, system, or feature13- User wants a technical deep-dive with diagrams14- A wiki catalogue section needs its content generated1516## Depth Requirements (NON-NEGOTIABLE)17181. **TRACE ACTUAL CODE PATHS** — Do not guess from file names. Read the implementation.192. **EVERY CLAIM NEEDS A SOURCE** — File path + function/class name.203. **DISTINGUISH FACT FROM INFERENCE** — If you read the code, say so. If inferring, mark it.214. **FIRST PRINCIPLES** — Explain WHY something exists before WHAT it does.225. **NO HAND-WAVING** — Don't say "this likely handles..." — read the code.2324## Procedure25261. **Plan**: Determine scope, audience, and documentation budget based on file count272. **Analyze**: Read all relevant files; identify patterns, algorithms, dependencies, data flow283. **Write**: Generate structured Markdown with diagrams and citations294. **Validate**: Verify file paths exist, class names are accurate, Mermaid renders correctly3031## Mandatory Requirements3233### VitePress Frontmatter34Every page must have:35```36---37title: "Page Title"38description: "One-line description"39---40```4142### Mermaid Diagrams43- **Minimum 2 per page**44- Use `autonumber` in all `sequenceDiagram` blocks45- Choose appropriate types: `graph`, `sequenceDiagram`, `classDiagram`, `stateDiagram-v2`, `erDiagram`, `flowchart`46- **Dark-mode colors (MANDATORY)**: node fills `#2d333b`, borders `#6d5dfc`, text `#e6edf3`47- Subgraph backgrounds: `#161b22`, borders `#30363d`, lines `#8b949e`48- If using inline `style`, use dark fills with `,color:#e6edf3`49- Do NOT use `<br/>` (use `<br>` or line breaks)5051### Citations52- Every non-trivial claim needs `(file_path:line_number)`53- Minimum 5 different source files cited per page54- If evidence is missing: `(Unknown – verify in path/to/check)`5556### Structure57- Overview (explain WHY) → Architecture → Components → Data Flow → Implementation → References58- Use Markdown tables for APIs, configs, and component summaries59- Use comparison tables when introducing technologies60- Include pseudocode in a familiar language when explaining complex code paths6162### VitePress Compatibility63- Escape bare generics outside code fences: `` `List<T>` `` not bare `List<T>`64- No `<br/>` in Mermaid blocks65- All hex colors must be 3 or 6 digits66
Full transparency — inspect the skill content before installing.