code-wiki

Generate technical documentation and Mermaid diagrams for software repositories.

Updated Jul 13, 2026
One-click install
npx skills add https://github.com/zangjeicy/Hermes --skill code-wiki-zangjeicy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-wiki
Source: https://github.com/zangjeicy/Hermes/tree/main/optional-skills/software-development/code-wiki
Command: npx skills add https://github.com/zangjeicy/Hermes --skill code-wiki-zangjeicy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

This Skill solves the challenge of understanding unfamiliar or undocumented codebases by automatically generating structured, human-readable documentation and visual architecture diagrams.

Core Features & Use Cases

  • Automated Documentation: Generates comprehensive READMEs, architecture overviews, and module-level deep dives.
  • Visual Mapping: Creates Mermaid-based class and sequence diagrams to visualize system flow and component relationships.
  • Use Case: When onboarding to a new repository, use this Skill to instantly generate a project wiki that maps out key modules, entry points, and data flows, allowing you to understand the system structure in minutes rather than hours.

Quick Start

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

Frequently Asked Questions about code-wiki

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

FAQPage Schema
How do I generate architecture documentation for an unfamiliar codebase?

You can generate architecture documentation for an unfamiliar codebase by using an automated tool that traverses the file system to analyze code and output structured technical docs. This process maps out key modules and entry points automatically.

Can I automatically create Mermaid diagrams to visualize code flow and component relationships?

Yes, you can automatically create Mermaid diagrams to visualize code flow. The generation process produces class and sequence diagrams directly from the analyzed codebase to map out system structure and component relationships.

What is the best way to speed up onboarding for a new software repository?

The best way to speed up onboarding for a new software repository is to generate an instant project wiki. By producing module-level deep dives and architecture overviews, new team members can understand the system structure in minutes rather than hours.

Does the codebase documentation generation work with multiple programming languages?

Yes, the codebase documentation generation applies to codebases of various programming languages. It requires only standard terminal access to perform the file system traversal and code analysis needed to produce the documentation artifacts.

How do I generate a complete project wiki from my current directory?

To generate a complete project wiki from your current directory, invoke the generation command in a standard terminal within the repository. The tool will analyze the local codebase and output a full documentation suite including READMEs and visual mapping.