DeepWiki 功能面向企业代码库提供自动化 Wiki 文档生成能力。用户可基于已授权的代码库、分支和版本，一键生成结构化的 Wiki 文档，帮助团队快速了解代码库整体架构、核心模块、关键逻辑与使用方式，降低代码理解成本和新人上手门槛。

• 该功能将分散在代码库中的项目结构、业务逻辑和技术实现沉淀为可阅读、可检索、可复用的知识资产，便于企业持续积累研发知识；
• 同时支持将生成的 Wiki 文档同步至 Comate 知识集，使代码库知识能够进一步应用于智能问答、研发辅助和团队协作场景，提升 Comate 对企业私有知识的理解能力和使用效果。
• DeepWiki 还支持按代码库、分支和版本管理 Wiki 文档，用户可持续更新并查看历史版本，确保文档内容与代码演进保持同步。
• 企业管理员可通过配置模型、生成模版和资源可用时间，灵活管理 Wiki 生成策略，满足不同企业在私有化部署、资源调度和文档规范上的要求。

注意，生成Wiki文档的模型消耗额度随代码库复杂度变化，请关注企业账单

一、代码库授权

1. 进入授权页

当您首次使用 DeepWiki，且当前账号满足以下条件时，系统会进入第三方授权落地页：

• 未授权任何代码仓库；
• 暂无历史生成的 Wiki 文档。

在该页面中，您可点击 「第三方授权管理」 进入代码库授权流程。

如果您已授权过代码库，或已有历史生成的 Wiki 文档，则进入 DeepWiki 首页。您也可以在首页通过 「代码库授权」 入口进入代码库授权管理页面。

2. 添加代码库授权

在授权弹窗中，您需要选择或填写以下信息：

• 代码库地址：需要接入 DeepWiki 的代码库地址；
• 账号：访问该代码库所使用的账号；
• 密码：访问该代码库所需的密码或凭证。
• 令牌：访问代码库所需的鉴权凭证。

填写完成后，提交授权信息。授权成功后，该代码库会出现在已授权仓库列表中，您即可在创建 Wiki 时选择该代码库下的 Repo、分支和版本。

如授权失败，请检查代码库地址、账号、密码是否正确，以及当前账号是否具备该仓库的访问权限。

3. 查看已授权代码库

您可在代码库授权页面查看当前账号已授权的代码库列表。完成授权的代码库，会在创建 Wiki 或更新 Wiki 时作为可选代码库来源。

4. 取消授权

对于不再需要使用的代码库，您可以在已授权代码库列表中点击 「取消授权」。

取消授权前，系统会进行二次确认，避免误操作。确认取消后，该代码库将从已授权代码库列表中移除，后续您将无法再基于该代码库创建新的 Wiki。

需要注意的是，取消代码库授权通常仅影响后续创建或更新 Wiki 时的代码库选择，不会自动删除已生成的历史 Wiki 文档。如需删除历史 Wiki，您需在 Wiki 首页或文档详情页中单独执行删除操作。

5.修改授权

对于需要修改授权的代码库，您可以在已授权代码库列表中点击 「修改」。

在授权弹窗中，您可以修改以下信息：代码库地址、账号、密码。

二、创建 Wiki文档

创建 Wiki 用于基于指定代码库、分支和版本生成结构化 Wiki 文档。您可在创建时选择 Wiki 模版，并按需将生成结果同步至个人知识集或组织知识集。

1. 选择代码库

在 DeepWiki 首页点击 「新建 Wiki」，系统会打开 「新建 Wiki」 弹窗。

首先需要选择代码库。若您已授权多个代码库，可在下拉列表中选择本次需要生成 Wiki 的目标代码库。 如果当前没有可选代码库，需要先完成代码库授权后再创建 Wiki。

2. 选择 Repo

选择代码库后，需要继续选择 Repo。

3. 选择分支与版本

选择 Repo 后，需要选择对应的 分支 和 版本。

• 分支：选择需要生成 Wiki 的代码分支。
• 版本：选择该分支下的目标 Commit 版本。 DeepWiki 会基于所选分支和版本对应的代码内容生成 Wiki 文档，因此建议选择稳定或需要沉淀文档的代码版本。

4. 选择 Wiki 模版

选择代码库信息后，需要选择 Wiki 模版。

Wiki 模版用于控制生成文档的结构和内容大纲。系统会根据客户需求提供内置模版列表，您可在下拉列表中选择合适的模版。

默认模版为：智能生成模版，AI 将根据代码库结构生成最佳模版

当鼠标点击模版详情时，可查看该模版的详情内容。模版详情展示的是当前模版内置的大纲，仅支持查看，不支持在创建 Wiki 时直接编辑。

5. 选择同步知识集

创建 Wiki 时，您可按需选择是否同步至知识集。

同步至知识集支持以下两类目标：

• 个人知识集：展示您有权限加入知识的个人知识集，支持多选。
• 组织知识集：展示您有权限加入知识的组织知识集，支持多选。

如果选择了知识集，Wiki 生成成功后可同步至对应知识集，用于后续知识沉淀、团队共享和智能问答场景。 如果暂时不需要同步，也可以不选择知识集，后续可在首页 Wiki 卡片或文档详情页中再次发起同步。

6. 提交生成

完成仓库、Repo、分支、版本、Wiki 模版及知识集选择后，点击 「确定」 发起 Wiki 生成任务。

提交成功后，系统会创建一个新的 Wiki 卡片，并进入 Wiki 生成中页面。生成过程中暂不支持下载或同步操作。页面会提示 Wiki 正在生成中，您可点击 「前往设置」 查看当前企业配置的资源可用时间。 待 Wiki 生成完成后，您可进入详情页查看文档内容，并进行更新、下载、删除或同步至知识集等操作。

三、管理 Wiki文档

当您已完成仓库授权，或已有历史生成的 Wiki 文档时，进入 DeepWiki 首页。首页用于集中管理已创建的 Wiki 文档，支持查看卡片、搜索 Wiki、更新 Wiki、同步至知识集，以及进入详情页查看完整文档内容。

每次提交生成任务都会形成一个 Wiki 文档记录，无论生成成功或失败，都会在首页以卡片形式展示。

1. 查看 Wiki 卡片

首页以卡片形式展示已创建的 Wiki 文档。每张 Wiki 卡片对应一次 Wiki 生成任务，您可以通过卡片快速了解该 Wiki 的基础信息、生成版本和当前状态。

状态说明如下：

• 生成中：当前 Wiki 正在生成中，生成完成后该状态会消失。
• 生成失败：最新一次生成任务失败；若生成任务超过 24 小时仍未完成，也会视为生成失败。查看后该状态会消失。
• 待查看：Wiki 已生成完成，等待您首次查看。首次进入详情页查看后，该状态会消失。

2. 搜索 Wiki

首页提供搜索框，支持您快速查找目标 Wiki。

您可以输入以下内容进行模糊搜索：

• 代码库名称；
• Commit Hash 值。

3. 更新 Wiki

当代码库内容发生变化，或需要基于新的版本重新生成 Wiki 时，您可以在首页 Wiki 卡片中点击 「更新wiki」。

点击后，系统会打开更新 Wiki 弹窗，并带入当前 Wiki 对应的代码库、Repo、分支等基础信息。您可以在弹窗中重新选择版本和 Wiki 模版，提交后生成新的 Wiki 版本。

不同状态下，更新按钮的可用规则如下：

• 生成中 状态：不支持更新。
• 生成失败 状态：支持更新。
• 待查看 状态：支持更新。
• 生成成功 状态：支持更新。

更新后生成的新任务会作为新的 Wiki 版本记录保存。属于同一 Repo 的生成任务，无论是新建 Wiki 还是更新 Wiki，都会在详情页中按分支汇总展示。

4. 同步至知识集

对于已生成成功的 Wiki，您可以在首页 Wiki 卡片中点击 「同步知识集」，将 Wiki 文档同步到个人知识集或组织知识集。

不同状态下，更新按钮的可用规则如下：

• 生成中 状态：不支持同步至知识集。
• 生成失败 状态：支持同步至知识集。
• 待查看 状态：支持同步至知识集。
• 生成成功 状态：支持同步至知识集。

四、文档详情页

您可以点击首页 Wiki 卡片，进入 Wiki 文档详情页，文档详情页用于查看和管理某个 Repo 下的 Wiki 内容。同一 Repo 的新建和更新记录会统一聚合展示，并按分支区分不同版本。

1. 查看 Wiki 正文

进入详情页后，页面展示当前 Repo 的 Wiki 正文内容。

2. 切换分支

您可以通过 分支下拉框 切换查看不同分支的 Wiki。

下拉框中展示当前 Repo 下所有生成过 Wiki 的分支。切换分支后，页面会展示对应分支下的 Wiki 内容和版本记录。

3. 查看历史版本

点击 「版本」下拉框 可查看当前分支下的全部生成版本。

4. 下载 Wiki

当 Wiki 生成成功后，您可以点击 「下载」 将文档下载到本地。

下载内容为当前版本的 Wiki 文档，多页面内容会合并为 Markdown/PDF/ Word文件。

生成中和生成失败状态不支持下载。

5. 更新 Wiki

点击 「更新」 可重新生成 Wiki。

系统会带入当前代码库、Repo、分支等信息，您可以重新选择版本和 Wiki 模版后提交生成。

不同状态下操作规则如下：

• 生成中：不可更新
• 生成失败：可更新
• 待查看：可更新
• 生成成功：可更新

6. 删除 Wiki

您可以点击「删除」 删除当前 Wiki 版本,删除前系统会进行二次确认。删除的wiki文档不可恢复，请谨慎操作。

五、管理后台

管理后台用于配置 DeepWiki 的企业级能力，包括查看企业使用数据、选择生成模型、管理 Wiki 生成模版，以及设置资源可用时间。

1. 查看企业数据概览

企业管理员可在管理后台查看 DeepWiki 的企业数据概览，了解企业内 DeepWiki 的整体使用情况。

数据概览包括：

• 使用用户数：累计使用过 DeepWiki 的用户数。
• Wiki 文档数：累计所有时间范围内提交的 Wiki 生成次数，包含生成成功和生成失败的任务。 部门管理员和普通成员不可查看企业数据概览。

2. 配置模型

企业管理员可在管理后台模型部分配置 Wiki 生成时使用的模型。

模型列表展示企业内部署的全部可用模型，企业管理员可从下拉列表中选择指定模型，用于后续 Wiki 文档生成。部门管理员和普通成员仅可查看当前配置的模型，不支持编辑。

同时支持一键跳转企业账单查看任务模型消耗情况。

3. 管理生成模版

企业管理员可在管理后台管理 Wiki 生成模版。生成模版用于定义 Wiki 文档的大纲结构，影响最终生成文档的内容组织方式。

支持以下操作：

• 新建生成模版：管理员可创建新的 Wiki 生成模版，需填写：模版名称：最多 60 个字符；模版大纲：系统提供默认 JSON 格式大纲，支持编辑，最多 20000 个字符。
• 查看已有模版：点击已有模版后，可查看该模版的具体内容。
• 删除已有模版：点击模版删除按钮后，可删除对应模版。删除前系统会进行二次确认，避免误操作。
• 编辑已有模版：点击已有模版的 「编辑」 按钮后，可对该模版进行修改。管理员可编辑：模版名称和模版大纲。
• 修改完成后，点击确认保存即可完成更新。

部门管理员和普通成员不可新增、编辑或删除生成模版。

4. 配置资源可用时间

企业管理员可配置企业资源用于 Wiki 生成的可用时间段。资源可用时间用于控制 DeepWiki 在哪些时间段可以使用企业资源执行 Wiki 生成任务。企业每日需至少配置 2 小时资源可用时间；部门管理员和普通成员仅可查看资源可用时间，不支持编辑。

默认情况下，系统会全选全部时间段。企业管理员可根据实际资源使用情况调整可用时间：

• 点击某个时间段，即表示选中该时间段；
• 再次点击已选中的时间段，即可取消选中；