DeepWiki让Github源代码秒变文档知识库

推荐语

DeepWiki，AI阅读助手，将GitHub源代码转化为知识库文档，极大提升代码理解和协作效率。

核心内容：
1. DeepWiki简介及其功能特点
2. DeepWiki的主要功能及应用场景
3. DeepWiki的基本使用步骤及项目文档查找、查看方法

杨芳贤

53A创始人/腾讯云(TVP)最具价值专家

前言

当我们在Github上看见或者使用到一个不错的开源项目，想深入使用和了解一下时，往往由于项目文档写的过于粗糙而止步。对于一个复杂的项目更是如此，面对成千上万行代码根本无法入手，让我们白白错失了很多学习的机会。最近发现一个不错的AI产品，可以将 GitHub 仓库转换为详细且易于阅读的结构化知识库文档，简直就是开发者福音，这个产品就是DeepWiki。

DeepWiki简介

DeepWiki 是 Devin 团队推出的 GitHub 代码仓库智能AI阅读助手，该工具可以自动将任何 GitHub 仓库转换为详细且易于阅读的知识库文档，并提供交互式图表和对话式 AI 助手，允许用户轻松理解仓库的技术细节、架构设计和使用方法。

限制

• 需要一定英文阅读能力

• 文档有时不能及时同步最新更改

优势

• 无需注册登录

• 免费使用

• 支持检索 Github 公共仓库以及私有库

• 提供AI助手辅助问答

DeepWiki官网

官网地址：https://deepwiki.com/

官网已经收录了非常多的开源项目文档并提供了搜索功能，可以直接在首页根据 关键词 查找自己需要的项目，对于没有展示的开源项目也可以自己添加检索解析。

DeepWiki的主要功能

• 对话式文档：用户直接向代码库提问，DeepWiki 给出详细的文档级解答。

• 深度研究：针对复杂问题，AI 进行更深入的分析和回答。

• 按需索引：支持用户请求 DeepWiki 索引尚未收录的公开仓库。

• 私有仓库支持：注册 Devin 账户，用户能为私有仓库生成文档。

• 交互式图表：生成交互式的代码架构图，帮助理解代码结构。

• 分享功能：生成的 Wiki 页面和问答结果可用链接分享。

DeepWiki的应用场景

• 开源项目学习：帮助开发者快速理解开源项目的代码结构和功能。

• 代码库文档生成：为缺乏文档的开源项目自动生成详细的维基文档。

• 团队协作与知识共享：基于分享 Wiki 页面和问答结果，方便团队成员同步信息。

• 代码审查与优化：辅助开发者快速定位代码问题提供优化建议。

• 教育与培训：作为教学工具，帮助学生学习真实世界的代码结构和开发实践。

DeepWiki基本使用

项目文档查找

在项目首页输入关键词查找自己想了解的项目，比如 Ollama，检索结果可能很多也可能没有，如果检索到多个记录DeepWiki会以Star数进行降序排列，一般多为第一个。

查看项目文档

比如我们对Vue2框架感兴趣（官方文档提供了国际化，官方文档当然更方便），我们可以在首页找到Vue项目，点击右下角箭头进入项目文档详情

项目文档详情包含了整个项目的文档检索整理，包含 简介、架构、构建与脚本、单文件组件、服务端渲染、集成与兼容 等

文档中除了文字还包含大量的图表信息，如架构图、流程图等，我们可以清晰的了解项目的整体结构和状态流转

DeepWiki检索过的文档不单单是文档更是一个知识库，分析总结的内容都会附带参考源文件信息，点击源文件可以查看源项目文件

AI问答助手

我们作为使用者和学习者，可以手动查看项目文档，也可以使用DeepWiki提供的AI问答助手，我们可以提问任何我们想了解的内容，只需要在项目文档底部的对话框中输入提示词即可

DeepWiki会根据提示词从文档知识库中检索相关内容，在左侧提供问题回复，在右侧列举引用的源文件及内容

如果我们想继续提问，可以在底部对话框中继续输入问题

DeepWiki会在之前对话记录的下方新增一个聊天记录，完全不影响查看之前的对话记录

针对复杂问题，如果AI助手的Chat无法提供令我们满意的答案时可以试试 Deep Research 功能，使用也很简单，只需打开【Deep Research】开关即可

使用 Deep Research 功能后，DeepWiki会先进行思考

思考和搜集完文档后会根据问题进行回复

添加项目文档

对于DeepWiki上还没有收录的Github仓库，我们添加到DeepWiki有2种方式：

方式一：将项目加入到官网

在首页点击【Add repo】

可以选择三种方式中的任意一种

这里以我之前写的一个MCP项目为例，输入Github项目地址，点击继续

等待DeepWiki检索

使用人比较多时，需要排队等待

检索完成后就可以查看了，从绘制的流程图来看分析的还是蛮准确的

方式二：修改项目链接

将项目地址域名中的“github”替换为“deepwiki”

https://github.com/microsoft/autogen将上面地址替换为下面https://deepwiki.com/microsoft/autogen

回车后即可进入到DeepWiki检索的项目文档（项目已检索过则会直接展示）

文档及对话分享

DeepWiki还支持 对话记录 和 项目文档 分享：

• 项目文档分享：分享整个项目文档

• 对话记录分享：分享整个对话记录（即使分享单个对话也是分享整个对话记录）

项目文档分享只需在项目文档详情右上角点击【Share】拷贝链接

对话记录分享，在对话记录或者右上角点击【Share】拷贝链接