wiki-generator

Extract system architecture details from codebases into navigable Wiki pages with Mermaid diagrams.

5.0k|548|Updated May 14, 2025
One-click install
npx skills add https://github.com/dtyq/magic --skill wiki-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wiki-generator
Source: https://github.com/dtyq/magic/tree/main/frontend/magic-web/.cursor/skills/wiki-generator
Command: npx skills add https://github.com/dtyq/magic --skill wiki-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

通过分析代码结构与依赖,自动提取系统总体架构、核心特有功能模块的实现细节,并生成互相关联的多页面 Wiki 结构文档集。作为项目的架构知识库守护者,还负责在日常开发中解答疑问,并在架构变更时自动维护文档。

Core Features & Use Cases

  • 自动梳理前端/后端代码结构,生成系统架构总览与模块地图。
  • 生成可导航的 wiki/sidebar.md,确保页面可从导航链接访问。
  • 为关键架构链路补充 Mermaid 图,并在文档末尾附上 Sources。
  • 在架构变更时自动更新相关文档,保持文档与代码的一致性。

Quick Start

在项目中执行 wiki-generator Skill,以生成或更新项目 Wiki 并确保文档与代码保持同步。

Frequently Asked Questions about wiki-generator

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

FAQPage Schema
How do I automatically generate architecture documentation from source code?

To generate architecture documentation automatically, this Skill analyzes your codebase structure and dependencies to extract system architecture details, producing navigable multi-page Wiki pages with Mermaid diagrams and a documented Sources section referencing code paths.

What is the best way to keep project documentation synced with code changes?

Keeping documentation synced with code changes is handled by automatically updating related Wiki pages when architecture modifications occur, ensuring navigable documentation with Mermaid diagrams remains consistent with the current codebase.

How does code analysis extract system architecture for a Wiki?

Code analysis extracts system architecture by identifying and organizing structural details and dependencies from a codebase into a cohesive Wiki, applying to large-scale frontend and backend projects to produce navigable pages with Mermaid diagrams and code path references.

Can I generate Mermaid diagrams for my project's architecture automatically?

Generating Mermaid diagrams for project architecture is supported by extracting key architectural links from the codebase and supplementing the navigable Wiki pages with these diagrams alongside a documented Sources section referencing code paths.

Does this automated Wiki generation work for both frontend and backend projects?

Automated Wiki generation works for both large-scale frontend and backend projects where up-to-date architectural knowledge is critical for onboarding, maintenance, and governance, organizing system architecture details into a cohesive navigable Wiki structure.

What are the limitations of using automated code analysis for Wiki generation?

Automated code analysis for Wiki generation relies on extracting identifiable architecture details from the codebase, meaning projects with obscure structures or missing dependencies may produce incomplete navigable Wiki pages with limited Mermaid diagrams and Sources references.