代码库变Wiki
指向一个代码仓库(本地或 GitHub 地址),自动生成整套 Wiki 文档:项目概览、架构说明、模块详解和 Mermaid 图表。
功能与用途
接手一个陌生仓库时,光看源码很难快速建立全局认识,而官方 README 又往往写得零散。这个 Skill 会先浅克隆或直接读取仓库、扫清目录结构和依赖清单,挑出最核心的 8 到 10 个模块,再写出项目概览、架构文档(含 Mermaid 流程图和调用时序图)、每个模块的职责与公开接口说明,以及上手文档。产出的是一整套 markdown 加 Mermaid 的参考文档,默认放在本地 Wiki 目录,只有你明确要求才写进仓库。它只负责「是什么、怎么运转」,不写项目存在的战略故事。
适用场景
- 刚加入一个开源项目或接手历史仓库,想先有一份系统的结构说明和:刚加入一个开源项目或接手历史仓库,想先有一份系统的结构说明和模块地图再开始改代码
- 团队内部仓库长期没有文档,想批量生成一份能直接在 GitHu:团队内部仓库长期没有文档,想批量生成一份能直接在 GitHub 上渲染的参考文档作为基础
- 做技术方案评审时需要一张能说清组件关系和数据流向的架构图,不:做技术方案评审时需要一张能说清组件关系和数据流向的架构图,不想手画
- 要给别人讲解某个系统的主流程,需要几份带参与者的时序图把调用:要给别人讲解某个系统的主流程,需要几份带参与者的时序图把调用链路画清楚
适用人群
- 软件工程师
- 技术文档工程师
- 技术团队新人导师
使用步骤
- 告诉它目标仓库:本地路径、当前目录,或直接给 GitHub 地址(远程会浅克隆到临时目录)
- 它会扫描目录结构、读取依赖清单和项目 README,建立技术栈和入口点认识
- 它挑出 8-10 个最重要的模块(大仓库会先报给你模块清单,让你有机会调整方向)
- 逐个产出 README、架构文档、模块详解、类图与时序图,以及上手指南
- 完成后它会回报全部文件路径,你可以打开查看或按需再让它补充某个模块
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-09-10
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Generate wiki docs + Mermaid diagrams for any codebase.
使用前准备
- 需要 git 在 PATH 中(远程仓库要克隆、本地要取提交号)
- 可选安装 pygount 得到语言占比统计
依赖与权限
- PATH
- 读取用户主动提供的内容