mcpField
W
whitepaper-audit

whitepaper-audit

github.com/glebis文档处理40152 次安装1 天前更新
代码仓库

关于 whitepaper-audit

用于审查 Markdown 白皮书的 Skill，结合确定性检查与独立的 LLM 评审，并将发现合并为分级报告。适合需要文档反馈的作者；只有明确要求时才会修改原文。

主要功能

  1. 01确定性文档检查
  2. 02独立的 LLM 评审
  3. 03去重并排序问题
  4. 04建议模式或明确请求的修复模式
  5. 05评审提示词评测用例

适用场景

  1. 01分享前审查 Markdown 白皮书
  2. 02检查可读性与失效链接
  3. 03为文档修订确定问题优先级

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/glebis/claude-skills --skill whitepaper-audit

安装后在 Claude Code 中输入/whitepaper-audit确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

DESIGN.md
evals/
README.md
RESULTS.md
evals/cases/
clean-control.md
missing-limitations.md
planted-defects.md
evals/stripped/
clean-control.md
missing-limitations.md
planted-defects.md
references/
audit-prompt.md
checklist.md
scripts/
check_doc.py
scripts/tests/
test_check_doc.py

详细介绍

whitepaper-audit

通过两条通道审查 Markdown 白皮书，并生成一份合并、按优先级排序的报告。

输入

  • 文档路径（必填）——Markdown 源文件，不是 PDF。
  • 指定受众（如未提供则询问）——audience-fit/jargon-undefined 的严重程度取决于受众。默认值： “技术从业者，非学术人士”。
  • 模式——recommend（默认）或 fix（仅在明确要求时使用）。

工作流

1. 通道 1 —— 确定性检查
python3 scripts/check_doc.py <doc.md> --offline [--target-grade N] [--allow ACRO]

移除 --offline 也会检查 http(s) 链接（HEAD→GET、超时；只有失效才会列为问题）。输出：JSON 问题，架构见 DESIGN.md。

2. 通道 2 —— LLM 评审

使用 references/audit-prompt.md 分派一个子 Agent（使用全新上下文——绝不要在同一上下文中评审自己编写的文档），填入 {PATH} 和 {AUDIENCE}，并加入 references/checklist.md 中的 [judge] 标准。评审者返回 JSON 问题。

评审校准规则具有约束力：必须提供逐字引用；低置信度时不得标记 P0；使用“需要验证”，不要说“事实错误”。

3. 合并

按（位置、问题类型）去重，同时保留两条通道的归属；先按 P0 → P1 → P2 排序，再按置信度排序。交叉引用：若通道 1 的失效链接能佐证某项主张（由评审者判断重要性），则列为 P1；装饰性链接 → P2。

4. 报告（默认模式）

撰写 Markdown 报告：结论摘要、问题表格（id、严重程度、置信度、位置、修复方式），然后列出详情。提出建议，不要编辑文档。

5. 修复模式（仅在明确要求时）

按 P0 优先应用修复。任何代码变更都必须遵循 superpowers 的测试驱动开发流程（先编写测试，确认其失败）。修正文案：编辑后重新运行完整审查，并报告已清除和仍存在的问题。

评估

在信任新的或已修改的评审提示词之前，先运行 evals/README.md 中的流程（植入缺陷 + 干净对照；通过标准见其中说明）。通道 1 由 scripts/tests/test_check_doc.py（pytest）覆盖。

文件

  • scripts/check_doc.py —— 通道 1（仅使用标准库；运行 --help 查看参数）
  • references/checklist.md —— 操作标准，适用于两条通道
  • references/audit-prompt.md —— 评审提示词模板
  • evals/ —— 评审验证用例 + 通过标准
  • DESIGN.md —— 架构决策（v0.2，经 Codex 审核）

评论

支持 Markdown