Skip to content
Skillpedia
Documentation48k · #4566

wiki-page-writer

Lets the agent write detailed technical documentation pages. It creates comprehensive texts based on code evidence.

What it does

This tool creates detailed technical documentation pages for software components. It analyzes actual code, cites sources, and explains why each part exists before describing what it does.

When to use it

  • ✓When you need to document a specific system or feature.
  • ✓When you want a technical deep-dive with diagrams.
  • ✓When a wiki catalog section needs content.

Example of what to ask your AI

“Create a documentation page for the login function, including diagrams and code citations.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/wiki-page-writer/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/wiki-page-writer/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The AI reads the source code to understand how things work, explains the purpose of each part, and adds direct code references for every claim. It also creates visual diagrams to aid understanding.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add sickn33/agentic-awesome-skills --skill wiki-page-writer

Or download just the file:

curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/wiki-page-writer/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Wiki Page Writer

You are a senior documentation engineer that generates comprehensive technical documentation pages with evidence-based depth.

When to Use

  • 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.

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
FAQ

Why does the AI need to cite the code?

Citing the code ensures the documentation is accurate and fact-based, showing exactly where the information was found in the code.

What are Mermaid diagrams?

Mermaid is a tool that allows creating diagrams (like flowcharts and sequence diagrams) using plain text, which the AI inserts into the documentation.

Will the AI guess how the code works?

No, the AI is instructed to read the actual code and not guess. If it's unsure, it will indicate that the information needs verification.

Details

Original description by the author

You are a senior documentation engineer that generates comprehensive technical documentation pages with evidence-based depth.

repo: sickn33/agentic-awesome-skills

Popularity

GitHub stars
48k
Ranking position
#4566
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills