AIGNE DocSmith 更新：更聰明的文檔編寫，更少的工作量

我們很高興宣佈 AIGNE DocSmith 0.9.0 正式發佈，這是我們迄今為止規模最大的測試版本（Beta Release）。此版本專注於新增多項功能與改進，讓建立與維護文檔變得更簡單、更快速且更具成本效益。歡迎分享您的 回饋 來協助塑造 DocSmith 的未來。

新功能亮點

API 文檔化繁為簡

您現在可以直接從 OpenAPI 規範生成完整的 API 文檔。只需將您的 OpenAPI 規範 URL 新增到設定中，運行 aigne doc generate，即可獲得包含端點、參數、範例等內容的全面 API 文檔。

sourcePaths:
  - https://api.example.com/openapi.json

這能節省數小時手動編寫 API 文檔的工作。

透過推理程度 (Reasoning Effort) 控制成本

全新的推理程度控制讓您能在品質、成本與速度之間取得平衡。將其設定為 low 以進行快速草稿（速度更快、成本更低），設定為 high 以用於正式發佈的文檔（品質更高，消耗的 Token 更多）。

thinking:
  effort: low  # minimal, low, medium, high

在快速迭代時使用 low，而在發佈團隊需要依賴的高品質文檔時使用 high。

圖表控制

過多的圖表可能會使文檔顯得雜亂。現在您可以透過 0-10 的等級來精確設定所需的圖表數量，其中 0 代表不產生圖表，10 代表最大程度的視覺化文檔。

diagramming:
  effort: 5  # 0-10 scale, 0 = no diagrams, 10 = maximum

清理您的文檔

新的 aigne doc clear 命令讓您可以選擇性地刪除不再需要的文檔，保持您的文檔集整潔有序。

自動開啟評估報告

運行 aigne doc evaluate 後，品質報告現在會自動在瀏覽器中開啟，為您提供更快速的反饋與改進建議。

更強的 AI 理解力

AI 檔案系統整合

AI Agent 現在透過新的 AI 檔案系統能更好地理解您的程式碼庫。這意味著：

更聰明的媒體處理

AI 現在可以分析並描述文檔中的圖像。將您的圖像包含在 source paths 中，AI 就會生成有意義的描述。

sourcePaths:
  - ./assets/images/**/*.{png,jpg}

效能提升

此版本的實際衡量數據顯示出顯著的進步：

已修復問題

此版本包含超過 40 項針對文檔生成、翻譯、發佈和檔案操作的修復。關鍵更新包括：

增強的發佈體驗

發佈過程現在更加順暢：

您可以在發佈時選擇性地更新品牌標識：

aigne doc publish --with-branding

開始使用

新用戶

npm install -g @aigne/cli@latest
aigne doc init
aigne doc create

現有用戶

更新至最新版本：

npm install -g @aigne/cli@latest
aigne doc upgrade

在您的 aigne.yml 中新增選用的配置欄位：

thinking:
  effort: low

diagramming:
  effort: 5

無破壞性變更——所有現有配置均可照常運作。

幕後技術

更好的提示詞 (Prompts)

增強的提示詞能產生更具表現力且結構更佳的文檔。我們標準化了 XML 標籤的使用並優化了格式指南。

Token 優化

多項改進降低了 Token 使用量：

後續計畫

我們正致力於開發：

資源

協助塑造 v1.0

我們正處於測試階段，並根據回饋積極完善 DocSmith。發現 Bug 了嗎？有功能建議？或是知道哪個社群需要新的文檔工具？歡迎在 社群 中分享您的想法，協助我們打造您心目中的文檔工具。

立即體驗

AIGNE DocSmith 0.9.0 讓文檔生成變得更聰明、更具成本效益。無論您是在編寫 API、程式碼庫還是整個項目的文檔，此版本提供的工具都能幫助您工作得更快、更好。

立即更新並體驗差異：

npm install -g @aigne/cli@latest