文檔審計工具:五維度文檔質量審覈 Skill

前言

技術文檔、對內規範、對外發布稿在上線前往往需要人工通讀:格式是否統一、表述是否含糊、敏感信息是否泄露、版本變更是否引入矛盾。純靠 checklist 容易漏項,完全交給大模型又缺少統一維度和問題分級。下面介紹 SkillHub 上的「文檔審計工具」,用固定審覈框架和三種模式,把審閱結果收斂爲可執行的整改建議。

這是什麼

「文檔審計工具」是社區來源(community)的 Agent Skill,座標爲 @user_d176c62a/doc-auditor,當前版本 1.0.0,分類爲 office-efficiency。發佈者爲 user_d176c62a,在 SkillHub 上標記 requires_api_key=false,即不依賴額外 API Key 即可使用。

它面向的是「成稿或準發佈稿」的質量把關:從結構格式、內容質量、事實準確性、安全隱私、風格一致性五個維度做審覈,並按 P0~P3 對問題定級,最後輸出結構化的整改建議。

核心功能

以下能力均來自 SkillHub 官方頁面說明,可按需裁剪使用場景。

五維審覈

  1. 結構格式:標題層級、列表與代碼塊、引用與鏈接等版式與結構是否合理。
  2. 內容質量:表述是否清晰、邏輯是否完整、是否存在明顯冗餘或缺口。
  3. 事實準確性:數據、版本、接口名、流程描述等是否與上下文一致(具體覈對仍依賴文檔本身與模型推理)。
  4. 安全隱私:是否可能泄露密鑰、內網地址、個人信息或不當對外信息。
  5. 風格一致性:術語、人稱、語氣是否在全文內保持統一。

問題定級

發現問題時按 P0~P3 分級,便於排期:嚴重問題優先處理,提示類問題可併入後續修訂。

三種審覈模式

官方明確區分三種模式,對應不同場景:

模式 適用場景(按官方描述理解)
深度審覈 重要文檔上線前全量審閱,五維逐項覆蓋
快速審覈 時間緊、需先抓高風險與明顯格式問題
變更審覈 針對 diff 或修訂稿,聚焦本次改動引入的風險

輸出形式

審覈結果以 結構化整改建議 呈現,便於直接轉成修訂任務或 PR 評論,而不是一段籠統的「寫得不錯」式評語。

適用文檔類型

官方列舉的適用範圍包括:內部文檔、外部發布文檔、技術文檔、政策文檔。未在資料中出現的類型,不宜默認支持,使用前可在對話中說明文檔性質與合規要求。

安裝與啓用

Skill 基於通用 SKILL.md 格式。在 SkillHub 上安裝時,可按平臺提示讓 Agent 參照安裝說明,或使用 SkillHub CLI 安裝到當前 Agent 的 skills 目錄。

1、安裝 SkillHub CLI(若尚未安裝)

command -v skillhub && skillhub --version

若未安裝,可使用官方推薦的一鍵安裝(完整包含 CLI 與默認 Skill):

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash

僅安裝 CLI 時:

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash -s -- --cli-only

更完整的說明見:SkillHub 安裝與優先源配置。

2、安裝本 Skill

安裝時必須用 --dir 指向當前 Agent 實際讀取的 skills 目錄,否則默認會裝到 ./skills/,Agent 可能無法識別。

skillhub install @user_d176c62a/doc-auditor --dir <你的 skills 目錄>

常見路徑示例(以官方安裝文檔爲準):

  • Cursor:~/.cursor/skills/
  • Claude Code:~/.claude/skills/
  • Codex:~/.codex/skills/ 或項目下的 .agents/skills/

也可按 SkillHub 技能頁提示,將下列意圖發給 AI,由其按 skillhub.md 完成安裝:

請根據 https://skillhub.cn/install/skillhub.md,安裝 `@user_d176c62a/doc-auditor`。

安裝後若 Agent 未立即加載新 Skill,需按你所用客戶端的慣例重啓或刷新技能列表(官方安裝文檔對目錄誤配的情況有說明)。

典型用法

官方資料未給出固定 shell 子命令;使用方式是在已啓用該 Skill 的 Agent 對話中發起審閱請求。下面步驟可與 SKILL.md 中的指引對齊,便於復現。

  1. 準備材料:提供待審 Markdown/純文本,或說明文件路徑與可讀範圍;變更審覈時附上改動摘要或 diff。
  2. 選定模式:在提示中寫明「深度審覈」「快速審覈」或「變更審覈」之一,並說明文檔類型(如技術文檔、對外發布稿)。
  3. 約定輸出:要求按 P0~P3 列出問題,並給出結構化整改建議(例如:位置、問題描述、建議修改方向)。
  4. 人工複覈:尤其是事實準確性與合規結論,應以業務權威來源爲準做終審,Skill 輸出作爲輔助清單。

示例提示(示意,可按項目規範改寫):

使用文檔審計工具,對下面這篇【技術文檔】做【深度審覈】。
請按五維度檢查,問題按 P0~P3 分級,並輸出結構化整改建議。

(正文或附件)

適用場景與注意

適合誰:需要統一文檔質量標準的內容團隊、技術寫作、合規或安全審查前的自檢環節;希望在 Cursor、Claude Code、Codex 等環境中用同一套審覈話術的人。

限制與注意:

  • 標籤標明 requires_api_key=false,不表示可離線運行;仍依賴你所用 Agent 的模型與上下文窗口。
  • 事實準確性維度無法替代權威數據源覈驗,涉密與對外發布稿須走組織內正式審批流程。
  • SkillHub 頁面統計(截至抓取時):評分 100000,下載 1518 次;數據以 SkillHub 技能頁 爲準。

結尾

「文檔審計工具」把結構、內容、事實、安全、風格五條線收進同一 Skill,並用深度、快速、變更三種模式區分審閱強度,輸出帶 P0~P3 分級的整改建議,適合在寫稿與發佈之間加一層可重複的機器輔助審計。

  • SkillHub 技能頁:https://www.skillhub.cn/skills/user_d176c62a/doc-auditor
  • API 條目:https://api.skillhub.cn/user_d176c62a/doc-auditor
  • 安裝說明:https://skillhub.cn/install/skillhub.md
羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜