工程開發
doc-audit avatar

doc-audit

審核 Packmind 文件,將 MDX 檔案與程式碼庫交叉比對,以偵測無效連結、過時的 CLI 參考及文件缺漏。

簡介

doc-audit 是一項先進的維護工具,專為使用 Packmind 來管理架構標準與工程規範的軟體工程團隊所設計。它確保位於 apps/doc/ 的終端使用者文件能與不斷演進的程式碼庫保持同步。透過執行多階段的結構分析,此技能能識別文件中的技術債,特別是針對程式碼更新速度超過手動內容更新時所產生的問題。本工具適用於技術主管、文件維護人員及開發者體驗工程師,他們需要在專案發布前或作為定期健康檢查的一部分,確保文件的高品質與可靠性。

  • 從 docs.json、CLI 指令定義與套件目錄中自動提取基準資料。

  • 透過平行探索代理程式審核各文件章節,包括入門指南、概念、工具、整合、治理與管理。

  • 偵測損壞的內部 MDX 連結、過時的 CLI 指令參考、不存在的架構概念以及誤導性的技術資訊。

  • 藉由比對實際原始碼領域與 CLI 指令與已記錄頁面,識別文件缺漏情形。

  • 產生包含錯誤嚴重性等級(ERROR、WARNING、INFO)的結構化 Markdown 報告 (doc-audit-report.md)。

  • 透過去重與嚴重性排序,協助使用者優先處理關鍵的文件錯誤。

  • 本技能僅負責偵測,不會直接修改 MDX 檔案,確保審核過程非破壞性。

  • 請確保儲存庫結構符合預期的 apps/doc/ 與 apps/cli/src/infra/ 路徑,以利精確交叉比對。

  • 適用於 CI/CD 流水線觸發、版本發布就緒檢查以及重構後的文件維護。

  • 產出的報告包含摘要表格與詳細發現,非常適合作為整合至 Pull Request 評論或自動化狀態檢查的依據。

  • 基準資料階段作為防護措施,確保審核永遠是針對應用程式原始碼的最新狀態進行,而非過時的快取版本。

倉庫統計

Star 數
275
Fork 數
13
Open Issue 數
50
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 上午02:22
在 GitHub 查看