跳转到主要内容

使用 Repo Wiki 生成项目文档

使用 Qoder IDE 的 Repo Wiki 功能自动生成并持续更新项目文档

Repo Wiki 是 Qoder IDE 提供的仓库文档生成功能,可基于代码仓库自动生成结构化的项目文档,并在代码变更后增量更新受影响的章节。

前提条件

  1. 已安装并登录 Qoder IDE,详见接入客户端/开发工具
  2. 当前 Qoder 版本为 Pro、Pro+ 或 Ultra。
  3. 项目为 Git 仓库且至少包含一次提交。

步骤一:打开项目并进入 Repo Wiki

在 Qoder IDE 中,点击左上角文件 > 打开文件夹,选择目标项目。
Qoder IDE 中已打开的项目文件结构
然后点击侧边栏的 Repo Wiki 图标,打开 Repo Wiki 面板。

步骤二:生成项目文档

在 Repo Wiki 面板中选择要生成文档的语言(如简体中文),点击生成
Repo Wiki 面板选择生成语言并点击生成
系统会先进行初始化分析,再逐步生成文档目录。生成速度与项目规模相关,需耐心等待。生成完成后可点击重新生成同步最新改动。
Wiki 生成完成,显示完整目录结构与重新生成按钮

步骤三:查看生成结果

生成的项目文档结构完整,通常包含项目概述、安装配置、用户指南、核心功能详解、技术架构、故障排除、附录等章节。 点击具体章节(如项目结构)可查看自动生成的详细描述与 Mermaid 图:
项目结构页面,包含自动生成的 Mermaid 架构图

步骤四:更新文档

初次生成后,系统会持续监控代码变更。如果修改了已被 Wiki 记录的内容(如函数签名、类定义、API 端点),系统会检测到代码与现有 Wiki 的不一致。点击更新即可仅重新生成受影响的章节。
检测到代码变更,提示更新 Wiki

共享 Repo Wiki

Wiki 共享仅适用于 Qoder 0.2.0 及以上版本。
在本地生成 Wiki 时,系统会在代码仓库中自动创建 .qoder/repowiki 目录。将该目录提交并推送到远程分支后,团队成员通过 git pull 即可获取生成的 Wiki 内容,无需额外配置。
.qoder/repowiki 共享目录结构

使用限制

  • 每个项目最多支持 10,000 个文件。若超出限制,建议在 Qoder 设置 > 代码库索引 > 索引排除中排除非必要路径。
  • 仅支持 Git 仓库,且仓库需至少包含一次提交。