前言¶
技术文档、对内规范、对外发布稿在上线前往往需要人工通读:格式是否统一、表述是否含糊、敏感信息是否泄露、版本变更是否引入矛盾。纯靠 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 官方页面说明,可按需裁剪使用场景。
五维审核¶
- 结构格式:标题层级、列表与代码块、引用与链接等版式与结构是否合理。
- 内容质量:表述是否清晰、逻辑是否完整、是否存在明显冗余或缺口。
- 事实准确性:数据、版本、接口名、流程描述等是否与上下文一致(具体核对仍依赖文档本身与模型推理)。
- 安全隐私:是否可能泄露密钥、内网地址、个人信息或不当对外信息。
- 风格一致性:术语、人称、语气是否在全文内保持统一。
问题定级¶
发现问题时按 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 中的指引对齐,便于复现。
- 准备材料:提供待审 Markdown/纯文本,或说明文件路径与可读范围;变更审核时附上改动摘要或 diff。
- 选定模式:在提示中写明「深度审核」「快速审核」或「变更审核」之一,并说明文档类型(如技术文档、对外发布稿)。
- 约定输出:要求按 P0~P3 列出问题,并给出结构化整改建议(例如:位置、问题描述、建议修改方向)。
- 人工复核:尤其是事实准确性与合规结论,应以业务权威来源为准做终审,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