工程開發
Global Documentation avatar

Global Documentation

確保技術專案符合標準化的全域文件規範,維護儲存庫與代理工作流程的一致性。

簡介

此技能作為技術文件編寫的專業品質保證機制,為代理程式提供基於既定儲存庫標準的嚴格遵循協議。它專為軟體工程師、技術寫作者以及管理大型程式碼庫的 AI 代理程式設計,確保專案級文件、架構規範和開發指南與全域標準保持同步。透過運用此技能,代理程式會將本機編輯內容與中央文件指令進行交叉比對,防止格式偏差,並確保 README 檔案、架構清單和技術規範遵循組織既定的結構準則。

  • 根據強制性的全域編碼和風格標準驗證技術文件。

  • 監控個別模組 README 與中央文件資料夾之間的一致性。

  • 協助自動審查架構規範(例如 architecture-refactoring/spec.md),確保符合全域專案需求。

  • 為文件更新提供情境感知指導,確保正確標記與交叉連結新檔案。

  • 支援與 agent-os/standards/global/documentation.md 整合,以便在編輯過程中進行即時規則評估。

  • 每當您在儲存庫內修改、建立或稽核文件檔案時,請使用此技能以確保它們符合強制性的結構規則。

  • 預期輸入:Markdown 文件檔案或規範清單。輸出:合規性檢查、結構建議與標準化格式調整。

  • 限制:此技能依賴於 agent-os/standards/global/documentation.md 檔案的存在;請確保此路徑在您的環境中可存取。

  • 最佳實踐:在完成合併請求或對技術規範進行重大更新之前,請務必呼叫此技能,以驗證全域交叉參考是否有效,並確認格式符合組織範本。

  • 適用於各種技術生態系統,包括 Go 後端、像 Beads 這樣的 CLI 優先問題追蹤器,以及複雜的架構重構文件。

倉庫統計

Star 數
3
Fork 數
1
Open Issue 數
1
主要語言
Go
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午10:49
在 GitHub 查看