AIGNE DocSmith：與程式碼同步交付的文件系統
撰寫優質文件，無需親自動手。
在軟體開發中，程式碼是結構，而文件則是藍圖。藍圖往往在結構不斷變動的過程中變得過時。如果文件能以與其描述的程式碼相同的節奏——以及智慧——同步演進，會是如何呢？
AIGNE DocSmith 不僅僅是另一個打字的地方。它是一種讓專案與其創作者之間保持對話的新方式。您可以將其視為一個與您的儲存庫（repository）保持同步的書記官：傾聽程式碼、提議大綱、撰寫故事，並隨著專案的演進進行修訂。
挑戰：未被記錄知識的迴響
我們都知道這個悖論。文件對於協作至關重要，卻往往是最先被遺忘的。知識存在於開發者的腦海中和程式碼的縫隙裡，而不是在 README 中。文件的脫節會拖慢團隊進度、掩蓋開發意圖，並增加新人入職的成本。撰寫優質文件，無需親自動手。（因為 AI 代理人永遠不會抱怨截止日期。😉）
DocSmith 的解決方案
DocSmith 基於 ArcBlock 的 AIGNE Framework構建，是一個 AI 驅動的代理人，能直接從您的原始碼自動建立詳細、結構化且多語言的文件。它將儲存庫視為唯一真理來源（source of truth）。利用代理人來規劃、起草和更新文件，使其隨程式碼變動而更新。讓人類參與結構規劃與編輯。讓文件隨版本構建一同交付，而不是在數週之後。
- 規劃：將程式碼庫映射為清晰、易於導航的大綱。
- 起草：生成精確、易於閱讀的頁面（必要時包含圖表）。
- 更新：根據針對性的回饋重新生成特定章節，而非重寫整份文件。
- 翻譯：以多種語言發佈，讓讀者無需精通您的預設語言。
- 發佈：讓最新版本成為人們實際閱讀的版本——無論是在 DocSmith 入口網站還是您自己的網站上。
ArcBlock 內部團隊在所有專案中使用 DocSmith，讓文件始終保持最新。
大拼圖中的一塊：AIGNE 生態系統
DocSmith 是 AIGNE 生態系統中的「Smiths」成員之一。如果說 DocSmith 是書記官（Scribe）——捕捉專案的故事——那麼 WebSmith 就是建築師（Architect）（將代理人轉化為網站），而 CodeSmith 則是工匠（Artisan）（審查並改進程式碼）。它們共享相同的 AIGNE Framework、CLI 和 Hub，因此您可以採用單一工具或整個工作坊，而無需改變您的工作流程。
快速上手
# 1) Install the AIGNE CLI
npm i -g @aigne/cli
# 2) Generate docs from your repo
aigne doc generate
# 3) Update a specific page with feedback
aigne doc update --docs overview.md --feedback "Add API examples and troubleshooting tips"
# 4) Translate and publish
aigne doc translate --langs zh --docs overview.md
aigne doc publish # choose hosted portal or self‑hosted未來展望
DocSmith 的發佈代表了一個新的開始。我們的路線圖專注於深化其智慧，並將其更深入地整合到開發生命週期中，為企業提供便捷的文件解決方案。
- 直接 CI/CD 整合：使文件成為構建過程中的動態產物。
- 文件品質評估：引入指標和報告，以衡量文件的清晰度和有效性。
- 增強使用者體驗：開發更直觀的組件來格式化和呈現資訊。
我們不僅是在開發一個工具；我們正在為軟體的理解和維護塑造一個新標準。
探索藍圖
我們邀請您體驗 AIGNE DocSmith。看看它是如何運作的，在您的專案中嘗試使用，並為其演進做出貢獻。在談論了這麼多關於藍圖和拼圖的哲學之後，理解它的最好方法就是親自嘗試。
立即免費試用 AIGNE DocSmith 並免費發佈您的文件，或將其自行託管在您自己的伺服器上。