生產力
write-docs avatar

write-docs

自動化 BrowserOS 功能文件的創建與維護,使用結構化且具備代碼庫感知的工作流程,生成精簡的 Mintlify MDX 頁面。

簡介

write-docs 技能是一個專門的工具,旨在協助開發人員與技術寫作者維護高品質、即時更新的 BrowserOS 生態系文件。透過分析 BrowserOS 代碼庫(特別是位於同層目錄中的伺服器組件),此技能可確保功能文件準確反映當前的實作細節。它簡化了技術文件的生命週期,從功能探索與代碼分析,過渡到生成標準化且對讀者友好的 MDX 檔案,直接對接基於 Mintlify 的文件平台。

  • 自動化代碼庫探索:利用 Grep 和 Glob 工具導航相關功能目錄,直接從源代碼中提取功能需求與核心機制。

  • 結構化 MDX 生成:遵循預定義的架構產生一致且專業的文件,包含標題、描述、「運作原理」與「快速入門」等區塊。

  • 整合截圖工作流:提供標準化程序來擷取 UI 元素並直接儲存至專案資源目錄,簡化視覺輔助內容的建立。

  • 導航同步:自動管理文件結構並更新 docs.json,確保新內容正確分類於網站導航層級中。

  • 實用且簡潔的風格:執行文件風格指南,優先考量使用者導向的說明與實際案例,而非內部實作細節,確保文件保持簡潔與可操作性。

  • 主要針對 BrowserOS 的各項功能,如 MCP 伺服器、排程任務與自動化工作流程。

  • 需要本地開發環境權限以精確掃描代碼庫。

  • 推薦的使用方式為由使用者指定功能,隨後由技能提示進行必要的螢幕截圖捕獲。

  • 將文件長度限制為最多一頁,以維持首次使用者的閱讀清晰度。

  • 設計用於無縫整合現有的 BrowserOS 文件工作流,包括支援透過 mint dev 指令進行本地預覽。

倉庫統計

Star 數
10,719
Fork 數
1,064
Open Issue 數
83
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月30日 下午04:31
在 GitHub 查看