Documentation Builder

Documentation Builder 是一項專門的代理技能，旨在彌合技術實作與開發者體驗之間的差距。它針對需要高品質、最新文檔而無需維護開銷的軟體工程師、技術文案和專案負責人。透過深入分析您的代碼庫、路由定義和基礎設施設置，該技能可以創建符合您特定技術堆疊的結構化參考資料。它在 Flask、React 或微服務架構等環境中表現出色，這些環境中同步 API 規範、數據流圖和入職指南通常非常耗時。

• 自動提取 API 簽名、請求/回應模式和身份驗證協議，以生成 OpenAPI/Swagger 規範。

• 生成全面的架構概覽，包括組件關係映射、系統邊界和技術堆疊說明。

• 產生多格式輸出，包括用於版本控制的 Markdown、用於網頁託管的 HTML 以及用於正式發行的 PDF。

• 自動建立語言特定的代碼範例（Python、JavaScript、Go、Java、cURL），以促進開發者採用。

• 構建教學性用戶指南，包括設置教程、環境配置步驟和針對新專案貢獻者的故障排除部分。

• 為數據管道、序列流和部署拓撲執行自動圖表生成，以視覺化複雜的系統邏輯。

• 在輸入中提供特定上下文，例如身份驗證方法 (JWT, OAuth) 或特定的 API 約束，以確保生成的文檔在技術上準確。

• 在迭代開發週期中使用此技能，使文檔與新功能部署同步，確保入職材料保持相關性。

• 當與清晰的代碼註釋配對時，輸出效果最佳，因為該技能會解析現有的代碼結構以推斷意圖和文檔部分。

• 儘管該工具高度自動化，但建議人工審查架構圖，以確保系統邊界符合組織標準。

• 輸入要求包括訪問您的存儲庫結構和任何相關技術規範；輸出產物已針對 GitHub、GitBook 以及標準靜態站點生成器（如 Docusaurus 或 MkDocs）進行了優化。