無論是小白還是資深軟件工程師,在工作中接手其他同事寫的項目代碼最怕的就是:
- 新人入職,對業(yè)務(wù)不熟悉,團隊也沒有技術(shù)沉淀,來什么活就干什么活,混一天是一天屎山代碼,只有它的鼻祖才知道怎么維護和增加功能需求又來了,產(chǎn)品、項目經(jīng)理既要、又要、也要,巴不得你明天就把活搞定,后天就能順利上線突然接手代碼,馬上讓你解BUG,對于小白而言一臉懵逼,不知道從何處下手,就算是來一個資深的大佬、技術(shù)專家、架構(gòu)師,短時間也無能為力等等
以上這些應(yīng)該就是大部分做開發(fā)的朋友們?nèi)粘C媾R的難題以及常態(tài);這些可能也就是導(dǎo)致如今為啥總是996、007的常態(tài)而不能真正的好好生活的原因之一吧!不過,隨著AI時代的來臨,有需求,就有跨時代產(chǎn)品的誕生!deepwiki
它來了:
https://github.com/AsyncFuncAI/deepwiki-open
deepwiki
是由Cognition Labs推出的一款 AI 驅(qū)動的開源工具,旨在幫助開發(fā)者快速理解GitHub上的代碼倉庫。它通過分析代碼、README和配置文件,自動生成結(jié)構(gòu)化的文檔和交互式圖表,并提供對話式AI助手,幫助開發(fā)者快速理解項目結(jié)構(gòu)和邏輯,在deepwiki
官網(wǎng)上已經(jīng)有許多生成好的代碼倉庫wiki:
https://deepwiki.com/
不過,目前 deepwiki 僅支持開源項目的生成,如果想要支持私有部署,則需要付一定的費用來支持,具體可以了解下 deepwiki 官方 API 的定價。
一 、deepwiki核心功能
- 自動生成結(jié)構(gòu)化文檔
DeepWiki 能自動將 GitHub 倉庫轉(zhuǎn)化為類似維基百科的文檔頁面,包含項目目標、核心模塊、依賴關(guān)系圖等。通過分析代碼邏輯,生成通俗易懂的說明,適合新手和資深開發(fā)者。
- 對話式 AI 助手
用戶可以通過自然語言向deepwiki
提問,例如"如何實現(xiàn)用戶鑒權(quán)?"或"解釋MVC架構(gòu)",AI 會基于代碼分析給出精準解答。支持中文等語言對話,增強全球開發(fā)者的使用體驗。
- 交互式圖表
自動生成可點擊的交互式圖示,包括類層次結(jié)構(gòu)、依賴關(guān)系圖和工作流程圖,用戶可以放大縮小,自由探索各模塊之間的關(guān)聯(lián)。
- 深度研究模式
面向高階用戶,deepWiki
支持運行高級分析任務(wù),如檢測潛在漏洞、建議優(yōu)化方向,或?qū)斍皞}庫與其他倉庫進行對比分析
二、deepwiki實戰(zhàn)
以我自己前一兩年開源的項目為例:QT-Sensor
https://github.com/Yangyuanxin/QT-Sensor
操作手法:
即可得到如下網(wǎng)頁:
以下是生成的wiki項目鏈接:
https://deepwiki.com/Yangyuanxin/QT-Sensor
這簡直寫得太好了!圖文并茂,比我們自己想的和考慮的還要周全!以后,即使沒有代碼,想要了解項目的架構(gòu)、代碼邏輯實現(xiàn)等將不再是難事!快來試試吧!閱讀原文,跳轉(zhuǎn)到該項目的wiki瀏覽觀摩學(xué)習(xí)下!