部落格

您的 AI 工具的好壞,取決於您的文件品質


現在每個工程團隊都在以某種形式使用 AI 工具:自動完成的程式碼助手、可以搜尋和修改程式碼庫的代理,以及回答關於系統和流程問題的內部工具。這些工具的承諾是透過提供即時取得相關知識的途徑來加速工程進度。

然而對大多數團隊來說,現實是這些工具在處理通用編碼任務時很有用,但在面對團隊自身系統的特定問題時卻顯得意外地弱。程式碼助手可以編寫一個 Python 函數,但不知道團隊的慣例。代理可以搜尋程式碼庫,但無法解釋為什麼支付服務會這樣架構。內部聊天機器人會對公司特定的系統產生幻覺,因為它所需要的知識存在於人們的腦海中和 Slack 討論串中,而不是在可搜尋的文檔中。

這不是 AI 模型的限制。這是它們能夠存取的上下文的限制。


上下文問題

AI 工具是根據上下文進行推理的。一個能看到當前檔案及其匯入內容的程式碼助手,能產生合理的完成結果。而一個同時還能看到專案架構文件、編碼慣例和決策歷史的程式碼助手,則能產生顯著更好的結果,因為它理解團隊所選擇的模式及其原因。

這適用於工程工作流程中的每一個 AI 工具。當一個內部代理被問到「計費系統如何處理退款?」時,只有在答案存在於該代理可以搜尋的某個地方時,它才能提供有用的答案。如果答案存在於八個月前的 Slack 討論串、從未轉錄的會議錄音,或資深工程師的記憶中,該代理就無從入手,要麼承認不知道,要麼更糟地捏造出一個聽起來合理但卻錯誤的答案。

AI 工具輸出的品質受限於該工具可獲得的已記錄上下文的品質。擁有完整、最新文檔的團隊,從其 AI 投資中獲得的價值,顯著高於沒有文檔的團隊。


文檔作為 AI 基礎設施

這重新框定了文檔問題,其方式往往比傳統論點更能吸引工程領袖。

文檔不再僅僅是給人類看的了。它是你技術棧中每個 AI 工具的訓練場。能記錄架構決策、系統行為、事件歷史和團隊慣例的自動撰寫文檔,建立了一個可供人類和 AI 代理查詢的知識庫。

當你的工程 Wiki 自動從 GitHub 活動、Slack 對話和會議記錄中撰寫出來時,產生的文檔就承擔了雙重職責:它是新員工的入職培訓資源,也是 AI 工具的上下文層。幫助新工程師理解支付服務的同一份文檔,也能幫助 AI 代理準確回答相關問題。

透過 MCP(模型上下文協定),已記錄的工程知識可以被任何 AI 代理存取,而無需自訂整合。文檔作為一個共享的上下文層,任何相容的工具都可以從中讀取,這意味著你在文檔上的投資會使你工作流程中每個 AI 工具的價值倍增。


回饋循環

這裡有一個值得詳細說明的良性循環。更好的文檔使 AI 工具更有用。更有用的 AI 工具使工程速度更快。更快的工程產生更多活動,並被自動撰寫文檔系統捕捉。更多被捕捉的活動使文檔更豐富。更豐富的文檔使 AI 工具更加有用。

儘早進入這個循環的團隊將擁有複利優勢:他們的 AI 工具隨著文檔的改善而改善,而他們的文檔隨著工程活動產生更多已記錄的上下文而自動改善。不記錄文檔的團隊則會受困於通用能力強但對其程式碼庫毫無用處的 AI 工具。


常見問題解答

哪些 AI 工具最能從文檔中受益? 回答關於公司特定系統問題的內部代理改善最大,因為它們的價值完全取決於是否擁有公司特定的上下文。程式碼助手在遵循慣例和架構感知建議方面有顯著改善。修改程式碼的編碼代理則受益於理解現有結構背後的推理。

這如何與 MCP 協同工作? MCP 是一個開放協定,讓 AI 代理在你的條款下讀取你的知識庫。你已記錄的工程知識成為任何相容 MCP 工具的上下文層,而不會將該知識吸收到工具的訓練數據中。文檔仍然是你的;AI 只是從中讀取。

我們已經有知識庫了。為什麼它對我們的 AI 工具不起作用? 大多數知識庫都過時、不完整,或者組織方式使得檢索困難。AI 工具需要最新、全面、可進行語意搜尋的文檔。自動撰寫文檔會自動更新並可按意義進行搜尋,從而解決了這三個問題。


相關閱讀:為什麼工程文檔很重要、自動撰寫文檔解析、記憶就是護城河。相關頁面:自動撰寫文檔、MCP、適合工程團隊。

The workspace that thinks with you.

Ready when you are.

The workspace that thinks with you.

Ready when you are.

The workspace that thinks with you.

Ready when you are.