
一、前言
DeepWiki是由人工智能初創(chuàng)公司Cognition推出AI代碼分析工具,依托于該公司旗下的AI產(chǎn)品Devin運(yùn)行,本質(zhì)上是一個(gè)提供結(jié)構(gòu)化知識(shí)管理的系統(tǒng),通過對(duì)開源項(xiàng)目進(jìn)行總結(jié)、提煉與結(jié)構(gòu)化整理的方式幫助人們更輕松的理解Github項(xiàng)目。
圖1 DeepWiki的架構(gòu)
二、功能亮點(diǎn)
基于代碼解析、文檔生成、生成交互式圖表等功能,一些特殊的設(shè)計(jì)使得DeepWiki的可用性顯著提高:
1.工作流程可視化:DeepWiki能夠根據(jù)文本內(nèi)容的流程說明自動(dòng)輸出可視化的流程圖輔助用戶快速理解項(xiàng)目工作原理;
2.對(duì)項(xiàng)目中提到的專有名詞解釋:對(duì)于項(xiàng)目中出現(xiàn)的專有名詞或?qū)I(yè)術(shù)語,DeepWiki會(huì)生成與之配套的文本和圖片進(jìn)行解釋;
3.高度交互性:DeepWiki將指定項(xiàng)目構(gòu)建為知識(shí)庫后可以依托于AI模型Devin實(shí)現(xiàn)與用戶的自然語言交互問答,即時(shí)解答關(guān)于項(xiàng)目原理、函數(shù)邏輯等問題。
三、使用示例
1.第一步非常簡單,只需要將需要解析的Github項(xiàng)目中的github替換為deepwiki即可,這里我們用RiboCode項(xiàng)目舉例:
圖2 使用DeepWiki
2.如果該項(xiàng)目未被索引過,則會(huì)出現(xiàn)以下界面,填寫郵箱后點(diǎn)擊Index Repository即可進(jìn)行知識(shí)庫構(gòu)建,可能需要等待2-10分鐘。之后用DeepWiki打開索引過的項(xiàng)目就無需等待了。

圖3 未索引項(xiàng)目
圖4 提交索引
3.DeepWiki構(gòu)建知識(shí)庫成功后,會(huì)輸出新的網(wǎng)頁:
(1)左側(cè)導(dǎo)航欄可視為一級(jí)目錄,包括:
l項(xiàng)目總結(jié)
l核心概念介紹
l命令行工具參考
l完整工作流解析
l高級(jí)應(yīng)用等模塊
(2)中間內(nèi)容區(qū)展示每個(gè)模塊的詳細(xì)正文,包括:
l代碼解析
l功能說明
l圖表展示等
(3)右側(cè)導(dǎo)航欄可視為二級(jí)標(biāo)題索引,幫助用戶快速定位到具體段落或章節(jié),提升閱讀效率。
圖5 DeepWiki界面總覽
4.DeepWiki根據(jù)RiboCode的項(xiàng)目生成了工作流程圖可供參考。
圖6 DeepWiki生成的RiboCode工作流程圖
5.DeepWiki中生成的專業(yè)術(shù)語解釋,圖文并茂。

圖7 DeepWiki給出的項(xiàng)目中專業(yè)術(shù)語解釋
6.直接向DeepWiki提問文中相關(guān)內(nèi)容,DeepWiki會(huì)結(jié)合具體的代碼給出相應(yīng)的回答。
圖8 提問展示

圖9 回復(fù)展示
四、結(jié)語
對(duì)于熟悉某個(gè)項(xiàng)目領(lǐng)域的開發(fā)者而言,使用DeepWiki更多是一種查漏補(bǔ)缺的方式,畢竟有些信息并不會(huì)完整地體現(xiàn)在README中。如果只是想快速了解軟件的某個(gè)參數(shù)或命令,DeepWiki的構(gòu)建與解析過程可能顯得有些“重",畢竟生成知識(shí)庫需要一定時(shí)間。但對(duì)于初次接觸某個(gè)項(xiàng)目的開發(fā)者而言,DeepWiki能夠幫助用戶建立更系統(tǒng)化的認(rèn)知,并對(duì)項(xiàng)目中的專有名詞、核心邏輯形成更深入的理解,此時(shí)花上5-10分鐘的時(shí)間等待是值得的。
