skills.rest
icyzh
icyzhCOMMUNITY
Explore all skills by this author →
Website𝕏@icyzhbeGitHub

code-wiki

Generate technical documentation and Mermaid diagrams from source code structure.

1|Updated Jul 31, 2026
Search Tags:#architecture#documentation#onboarding#mermaid#wiki#code-analysis
One-click install
npx skills add https://github.com/icyzh/hermes-web --skill code-wiki-icyzh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-wiki
Source: https://github.com/icyzh/hermes-web/tree/main/optional-skills/software-development/code-wiki
Command: npx skills add https://github.com/icyzh/hermes-web --skill code-wiki-icyzh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git.

What problem does it solve?

This Skill solves the challenge of maintaining up-to-date documentation for complex codebases by automating the creation of architectural overviews, module maps, and technical diagrams.

Core Features & Use Cases

  • Automated Documentation: Generates comprehensive READMEs, architecture guides, and module-level deep dives.
  • Visual Architecture: Automatically creates Mermaid diagrams for system flows, class relationships, and sequence workflows.
  • Use Case: When onboarding to a new repository, use this Skill to instantly generate a structured wiki that maps out the project structure, key entry points, and data flow, saving hours of manual exploration.

Quick Start

Invoke the code-wiki skill to generate a full documentation suite for the current repository.

Frequently Asked Questions about code-wiki

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate technical documentation and architecture diagrams for a git repository?▼

Generate technical documentation and architecture diagrams for a git repository by analyzing source code structure and manifests to automatically produce structured markdown artifacts and Mermaid diagrams.

Can I automatically create Mermaid diagrams for codebase onboarding and architectural review?▼

Yes, you can automatically create Mermaid diagrams for codebase onboarding and architectural review by analyzing the repository to map system flows, class relationships, and sequence workflows into visual markdown artifacts.

Does generating a codebase wiki require git for repository tracking?▼

Yes, generating a codebase wiki requires git for repository tracking and standard file system access to analyze the source code structure and manifests accurately.

What is the best way to document complex codebases across various programming languages?▼

The best way to document complex codebases across various programming languages is to automate architectural overview generation and module-level deep dives, saving hours of manual exploration during project maintenance.

How do I map project structure and data flow when onboarding to a new repository?▼

Map project structure and data flow when onboarding to a new repository by analyzing source code and manifests to instantly generate a structured wiki covering key entry points and module relationships.

What are the limitations of automated codebase documentation for project maintenance?▼

Limitations of automated codebase documentation include requiring git for repository tracking and standard file system access, while output is constrained to structured markdown artifacts and Mermaid diagrams.

Related Skills

Explore More Software Engineering Skills→
benchflow-aibenchflow-ai
317

arch-audit

Analyze Python source structure to identify module splitting and refactoring candidates.

Official
Advanced
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
phuhao00phuhao00
12

code-analyst-agent

Analyze source code to identify symbols, call graphs, and architectural patterns.

Community
Intermediate
B4sanB4san

documentation

Generate project documentation including READMEs, API docs, and Mermaid/PlantUML architecture diagrams.

Community
Intermediate