Mini-Wiki：AI驱动的全自动代码库文档生成工具，一键构建专业级Wiki知识库

一、Mini-Wiki是什么

Mini-Wiki是一款基于skills.sh生态体系的开源AI驱动文档生成Skill（技能包），核心定位是零人工干预、全自动将代码仓库转化为专业级、结构化Wiki文档的效率工具。它深度融合大语言模型能力，以“一行命令、一键生成”为核心，彻底解决传统开发场景中“文档滞后于代码、手动编写耗时费力、架构图缺失、内容易脱节、维护成本高”的行业痛点，让开发者从繁琐的文档编写工作中解放，专注核心开发。

作为AI时代的“文档自动化引擎”，Mini-Wiki并非传统Wiki编辑系统，而是代码库的智能文档生成器——它不提供可视化编辑界面，而是通过扫描、解析、理解项目源码，自动输出包含项目概述、模块解析、API说明、架构关系图、代码示例、交叉链接的完整Markdown格式Wiki文档，同时支持增量更新、多语言适配、插件扩展，兼容几乎所有主流编程语言与项目架构，是个人开发者、中小型研发团队、开源项目维护者的必备效率工具。

项目采用MIT开源协议，源码完全开放，可自由使用、修改、分发，无商业使用限制；核心基于Python开发，依托skills.sh的轻量化运行环境，无需复杂部署，通过npx一键安装即可使用，适配Windows、macOS、Linux全平台，兼顾轻量化与强大功能。

二、功能特色

Mini-Wiki以“AI智能、全自动、轻量化、高适配、易扩展”为核心设计理念，功能覆盖文档生成全流程，兼具实用性与专业性，核心特色如下：

1. 全链路AI智能分析，深度理解项目

• 技术栈自动识别：无需配置，自动扫描项目文件，精准识别编程语言（Python/Java/Go/JS等）、框架（SpringBoot/Vue/React/Django等）、依赖库、配置文件，生成精准的技术栈清单。

• 模块结构智能拆解：深度解析项目目录结构、文件依赖、代码调用关系，自动划分核心模块、子模块、工具类、入口文件，梳理清晰的项目层级关系。

• 代码语义理解：基于大模型解析函数、类、接口的注释与逻辑，提取核心功能、参数说明、返回值、使用场景，自动生成专业API文档与代码说明。

2. 可视化架构自动生成，告别手绘图表

• Mermaid架构图一键生成：自动分析项目模块依赖、服务调用、数据流向，生成标准Mermaid格式流程图、类图、组件图、部署图，直接嵌入Wiki文档，无需Visio、DrawIO等工具手动绘制。

• 架构图动态更新：支持随代码变更自动更新架构图，确保文档与代码架构完全同步，解决“图档过时、与实际不符”的问题。

• 多类型图表适配：覆盖单体应用、微服务、前后端分离、CLI工具等多种架构，自动匹配图表类型，清晰展示项目整体设计。

3. 源码级交叉链接，文档与代码无缝打通

• 代码块精准关联：文档中所有代码示例、函数引用、文件路径，均自动生成GitHub/GitLab源码跳转链接，点击直接定位对应代码行，实现“文档→代码”一键直达。

• 文档内部交叉引用：自动识别文档内模块、API、章节的关联关系，生成内部交叉链接，构建网状知识结构，提升文档查阅效率。

• 版本关联绑定：支持绑定代码仓库版本，文档与特定Commit/Tag关联，确保不同版本文档对应精准代码。

4. 增量更新机制，维护成本趋近于零

• 变更智能检测：自动对比项目文件修改记录（基于Git），仅识别新增、修改、删除的文件与代码，无需全量重新生成。

• 局部文档更新：针对变更内容，仅更新对应模块的文档片段，保留原有文档内容、格式、手动补充信息，避免覆盖人工优化内容。

• 高效更新效率：大型项目文档更新从“小时级”降至“秒级/分钟级”，彻底解决“代码迭代快、文档更新慢”的矛盾。

5. 多语言与格式适配，满足全球化需求

• 双语文档生成：同时支持中文、英文双版本Wiki文档自动生成，适配国内团队与开源项目国际化需求。

• 标准Markdown输出：生成文档遵循GitHub Flavored Markdown（GFM）规范，支持代码高亮、表格、列表、引用、公式等全格式，可直接用于GitHub Wiki、GitBook、Docusaurus、VuePress等平台。

• 格式自定义：支持文档标题、层级、代码块样式、图表主题的基础配置，适配不同团队的文档规范。

6. 插件化扩展体系，功能无限延伸

• 内置核心插件：自带API文档增强、变更日志（CHANGELOG）生成、代码复杂度分析、Git提交记录解析、多语言同步、文档导出（Docusaurus/GitBook格式）等插件。

• 自定义插件开发：支持开发者基于Python编写自定义插件，扩展文档生成规则、新增图表类型、对接私有模型、适配特殊项目架构，无功能上限。

• 插件市场兼容：深度兼容skills.sh插件生态，可一键安装第三方共享插件，持续拓展能力边界。

7. 轻量化零部署，开箱即用

• 一行命令安装：无需配置环境、无需部署服务，通过npx skills add trsoliu/mini-wiki一键安装，即装即用。

• 无侵入式运行：不修改项目源码、不添加依赖文件、不占用系统资源，仅在生成文档时读取项目文件，对开发流程无任何影响。

• 全平台适配：完美支持Windows、macOS、Linux系统，兼容本地开发、服务器、CI/CD流水线等多种运行场景。

三、技术细节

1. 核心技术架构

Mini-Wiki采用“三层架构+插件化引擎”的技术设计，整体轻量化、高内聚、低耦合，核心架构如下：

• 底层解析层（Parser Layer）

• 基于Python的AST抽象语法树解析：针对主流编程语言（Python/JS/Java/Go），通过AST解析代码结构，提取类、函数、变量、注释、依赖关系。

• Git集成模块：对接Git命令行，读取仓库Commit历史、文件变更记录、分支信息，为增量更新提供数据支撑。

• 文件扫描引擎：递归遍历项目目录，过滤非代码文件（日志、缓存、依赖包），分类识别配置文件、入口文件、工具类、测试文件。

• 中间AI处理层（AI Processing Layer）

• 大模型对接模块：默认对接通义千问、GPT-3.5/4等主流大模型，支持本地模型（Llama 2、ChatGLM）私有化部署配置。

• 文档生成引擎：基于AI分析结果，按照预设Wiki模板（项目概述→技术栈→模块解析→API文档→架构图→使用指南），自动生成结构化Markdown内容。

• Mermaid图表生成器：根据模块依赖、代码调用关系，自动生成Mermaid语法图表，支持流程图（flowchart）、类图（classDiagram）、组件图（componentDiagram）。

• 上层应用层（Application Layer）

• skills.sh兼容层：遵循skills.sh Skill规范，实现安装、运行、配置、更新的标准化接口，无缝融入skills.sh生态。

• 增量更新控制器：对比文件哈希值、Git变更记录，精准定位修改内容，驱动局部文档更新。

• 插件管理器：负责插件的加载、注册、调用、生命周期管理，支持插件热插拔。

2. 核心技术栈

• 开发语言：Python 3.8+（核心逻辑、解析、AI对接）

• 依赖库：

• 代码解析：ast（Python内置）、tree-sitter（多语言AST解析）

• Git操作：gitpython

• AI对接：openai、dashscope（通义千问）、自定义模型SDK

• 文档处理：markdown、pyyaml、jinja2（模板渲染）

• 工具库：click（CLI命令）、tqdm（进度条）、loguru（日志）

• 运行环境：Node.js（skills.sh依赖，用于安装与启动）、Python 3.8+

• 协议规范：skills.sh Skill V1协议、Markdown GFM规范、Mermaid v10规范

3. 文档生成核心流程

Mini-Wiki的文档生成全流程无需人工干预，共分为6个核心步骤：

1. 项目扫描：启动后读取目标项目路径，遍历所有文件，过滤无效文件，生成文件清单。

2. 深度解析：对代码文件进行AST解析，提取代码结构、注释、依赖；读取配置文件，识别技术栈与框架。

3. AI分析：将解析结果输入大模型，分析项目功能、模块作用、代码逻辑、使用场景，生成文档核心内容。

4. 图表生成：基于模块依赖与调用关系，自动生成Mermaid架构图、流程图。

5. 文档渲染：通过Jinja2模板，将AI内容、图表、代码链接、目录结构渲染为完整Markdown文档。

6. 输出存储：将生成的中文、英文文档保存至项目docs/目录，支持自定义输出路径。

4. 增量更新核心原理

增量更新是Mini-Wiki的核心技术优势，原理如下：

• 文件指纹记录：首次生成文档时，为每个代码文件生成MD5哈希值，记录文件版本与修改时间。

• 变更对比：再次运行时，重新计算文件哈希值，与历史记录对比，识别新增（无指纹）、修改（指纹变化）、删除（指纹消失）的文件。

• 局部重构：仅针对变更文件对应的文档模块，重新进行AI分析与内容生成，保留未变更模块的原有内容。

• 内容合并：将新生成的局部文档与原有未变更内容合并，保持文档整体结构与格式一致。

四、应用场景

Mini-Wiki适配全类型开发项目、全周期文档需求，核心应用场景覆盖个人、团队、企业多个维度：

1. 开源项目维护

• 场景痛点：开源项目Star增长快，但文档缺失、更新滞后，导致用户上手难、贡献者参与门槛高。

• Mini-Wiki价值：一键生成完整Wiki文档，包含安装指南、API说明、架构图、贡献指南；代码迭代后增量更新，确保文档与源码同步，提升项目口碑与用户留存。

2. 中小型研发团队

• 场景痛点：团队人力有限，开发者无暇编写文档；项目迭代快，文档维护成本高；新员工入职需手动梳理项目结构，上手周期长。

• Mini-Wiki价值：全自动生成团队内部Wiki知识库，清晰展示项目架构、模块功能、代码规范；新员工通过文档快速了解项目，降低沟通成本；增量更新确保文档实时有效，助力团队知识沉淀。

3. 个人开发者项目

• 场景痛点：个人项目多、精力有限，无时间写文档；项目长期维护时，易遗忘代码逻辑；项目分享时无专业文档，影响展示效果。

• Mini-Wiki价值：零成本生成专业级文档，梳理个人项目逻辑；便于后续维护与二次开发；分享至GitHub时，完整Wiki提升项目专业度，吸引更多关注。

4. 老项目重构与迭代

• 场景痛点：老项目无文档、代码混乱、架构不清晰；重构时需花费大量时间梳理代码逻辑；迭代时新增功能无文档记录。

• Mini-Wiki价值：自动解析老项目结构，生成架构图与模块说明，帮助开发者快速理解系统；重构后一键更新文档，记录变更内容；迭代时增量维护，确保新功能文档同步上线。

5. 技术培训与教学

• 场景痛点：教学项目、Demo案例需配套文档；培训时需展示项目架构与代码逻辑；学员自学时无参考文档。

• Mini-Wiki价值：为教学项目生成标准化文档，包含步骤说明、代码解析、架构图解；作为培训辅助材料，提升教学效率；方便学员课后自学与实践。

6. CI/CD自动化集成

• 场景痛点：代码提交后需手动更新文档，易遗漏；文档更新不及时，导致测试、运维人员参考错误信息。

• Mini-Wiki价值：集成至GitHub Actions、GitLab CI等流水线，代码合并后自动触发Mini-Wiki更新文档，实现“代码提交→文档自动更新→自动部署”全流程自动化，确保文档实时同步。

五、使用方法

Mini-Wiki的使用极简便捷，全程无需复杂配置，核心分为“安装→首次生成→增量更新→高级配置”四个步骤，适配所有开发者：

1. 环境准备

• 安装Node.js 14.0+（用于运行skills.sh，官网：https://nodejs.org/）

• 安装Python 3.8+（用于运行Mini-Wiki核心逻辑，官网：https://www.python.org/）

• 配置Git环境（用于增量更新，非必需但推荐）

2. 一键安装

打开终端（Windows CMD/PowerShell、macOS/Linux Terminal），执行以下命令，自动安装skills.sh与Mini-Wiki：

# 全局安装skills.sh（仅首次需执行）
npm install -g @skills.sh/cli

# 安装Mini-Wiki技能包
npx skills add trsoliu/mini-wiki

安装完成后，终端提示“✅ Skill installed: mini-wiki”，即表示安装成功。

3. 首次生成文档

进入目标代码仓库根目录（包含.git文件夹或项目源码的目录），执行以下命令：

# 基础命令：生成中文+英文文档
skills run mini-wiki

# 自定义命令：指定输出目录、仅生成中文、对接本地模型
skills run mini-wiki --output ./my-docs --lang zh --model local-llama

执行后，终端显示扫描进度、AI分析进度、文档生成进度；完成后，在项目根目录生成docs/文件夹，包含：

• README.md（中文主文档）

• README.en.md（英文主文档）

• architecture/（Mermaid架构图文件）

• api/（API详细文档）

4. 增量更新文档

项目代码修改后，无需任何配置，直接在项目根目录重新执行相同命令：

skills run mini-wiki

工具自动检测文件变更，仅更新对应模块文档，保留原有手动修改的内容（如补充的说明、优化的语句），更新速度极快（大型项目约10-30秒）。

5. 高级配置（可选）

在项目根目录创建.mini-wiki.yml配置文件，自定义文档生成规则：

# 基础配置
project_name: "My Project"
author: "trsoliu"
version: "1.0.0"

# 语言配置
languages:
 - zh
 - en

# 忽略文件/目录（无需生成文档）
ignore:
 - node_modules/
 - __pycache__/
 - dist/
 - "*.log"

# AI模型配置
ai:
 provider: dashscope # 可选：openai/dashscope/local
 api_key: "your-api-key"
 model: "qwen-max"

# 插件启用
plugins:
 - api-doc-enhancer
 - changelog-generator
 - diagram-plus

配置后，再次运行命令将按照自定义规则生成文档。

6. 插件使用

查看可用插件：

skills run mini-wiki --list-plugins

安装第三方插件：

skills run mini-wiki --add-plugin plugin-name

运行时启用指定插件：

skills run mini-wiki --plugins api-doc-enhancer,changelog-generator

六、竞品对比

当前文档生成工具市场分为传统Wiki工具、AI辅助编辑器、全自动代码文档工具三类，Mini-Wiki与主流竞品的核心对比如下：

竞品对比核心表

核心优势总结

1. 对比传统工具（MkDocs/Sphinx）：Mini-Wiki无需手动编写文档、无需配置复杂规则，AI全自动生成，自带架构图与源码链接，增量更新大幅降低维护成本。

2. 对比企业级工具（Confluence）：Mini-Wiki开源免费、零部署、轻量化，专注代码库文档，无需团队协作、权限管理等冗余功能，性价比极高。

3. 对比在线平台（GitBook）：Mini-Wiki本地运行、数据隐私安全，深度适配代码库，自动关联源码与架构，而非单纯的文档编辑工具。

4. 核心差异化：唯一实现“AI全自动分析+架构图自动生成+源码交叉链接+增量更新”全链路能力的轻量化开源工具，无替代品。

七、常见问题解答

Mini-Wiki支持哪些编程语言？

目前支持Python、JavaScript、TypeScript、Java、Go、PHP、Ruby、Rust等主流编程语言；通过tree-sitter扩展，可适配几乎所有编程语言，特殊语言可通过自定义插件支持。

生成的文档可以手动修改吗？修改后会被覆盖吗？

可以手动修改。Mini-Wiki采用增量更新机制，仅更新代码变更对应的文档模块，完全保留手动修改的内容，不会覆盖人工优化的部分；只有代码对应内容变更时，才会更新该模块。

需要付费吗？支持私有化部署吗？

Mini-Wiki完全开源免费（MIT协议），无任何付费功能、无使用限制。支持私有化部署：可对接本地大模型（Llama 2、ChatGLM、Qwen Local），所有数据本地处理，不上传第三方服务器，保障代码隐私安全。

支持Windows/macOS/Linux全平台吗？

完全支持。只要安装Node.js与Python环境，三大系统均可一键安装、正常运行；终端命令与使用方式完全一致，无平台差异。

生成的文档可以直接用于GitHub Wiki吗？

可以。生成的文档为标准GitHub Flavored Markdown格式，包含目录、代码高亮、Mermaid图表、链接，直接将docs/目录内容复制到GitHub Wiki仓库，即可完美展示。

大型项目（10万行+代码）生成速度如何？

首次生成：10万行代码项目约5-10分钟（取决于AI模型响应速度）；增量更新：仅需10-30秒，仅扫描变更文件，速度极快。

可以对接自己的大模型API吗？

可以。在.mini-wiki.yml配置文件中，修改ai.provider为custom，填写自定义模型的API地址、密钥、模型名称，即可对接私有大模型。

插件如何开发？有开发文档吗？

插件基于Python开发，遵循skills.sh插件规范。项目docs/plugins/目录包含完整的插件开发文档、示例插件、API说明，开发者可快速编写自定义插件，扩展文档生成能力。

没有Git的项目可以使用吗？

可以使用。无Git时，仅支持全量生成（无法增量更新）；每次运行会重新扫描所有文件，生成完整文档；建议项目接入Git，以体验增量更新的高效能力。

生成的文档支持导出为PDF/Word吗？

原生输出为Markdown格式，可通过第三方工具（如pandoc、Markdown PDF插件）将生成的Markdown文档转换为PDF、Word、HTML等格式，适配不同交付需求。

八、相关链接

• GitHub源码仓库：https://github.com/trsoliu/mini-wiki

九、总结

Mini-Wiki作为skills.sh生态中极具实用性的AI文档生成工具，以“全自动、轻量化、高适配、易扩展”为核心，彻底解决了开发者与团队在项目文档编写、维护过程中的核心痛点。它依托大模型的智能分析能力，实现了从项目扫描、代码解析、架构图生成到文档渲染、增量更新的全流程自动化，无需人工干预即可生成包含专业内容、可视化图表、源码链接的高质量Wiki文档；同时凭借开源免费、零部署、全平台适配、插件化扩展的优势，完美适配开源项目、研发团队、个人开发者、老项目重构等多元场景，大幅提升开发效率、降低文档维护成本、助力知识沉淀与传承。相较于传统文档工具与AI辅助编辑器，Mini-Wiki真正实现了“代码即文档”的理想状态，是AI时代开发者提升效率、规范项目管理的必备工具，为代码库的文档化、标准化提供了极简高效的解决方案。