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

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

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

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