mcpField
L
ln-610-docs-auditor

ln-610-docs-auditor

github.com/levnikolaevich文档处理584315 次安装2 天前更新
代码仓库

关于 ln-610-docs-auditor

用于协调文档审计的 L2 Coordinator,面向需要检查文档结构、内容、注释和事实准确性的团队。它委派给四个专门 Worker,并要求研究标准作为最终评分依据。

主要功能

  1. 01审查文档结构与相关性
  2. 02检查语义内容和代码注释
  3. 03核验文档中的事实
  4. 04协调四个专门审计 Worker
  5. 05汇总发现并生成整改报告

适用场景

  1. 01执行涵盖多个文档方面的审计
  2. 02依据研究来源验证文档问题
  3. 03汇总 Worker 结果并规划整改

安装

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

$npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-610-docs-auditor

安装后在 Claude Code 中输入/ln-610-docs-auditor确认已加载。

包含的文件

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

references/
audit_final_report_contract.md
epistemic_protocol.md
evaluation_coordinator_runtime_contract.md
evaluation_research_contract.md
evaluation_summary_contract.md
meta_analysis_protocol.md
research_tool_fallback.md

详细介绍

路径: 文件路径(references/、../ln-*)相对于此技能目录。

类型: L2 协调器 类别: 6XX 审计

文档审计员

必须阅读

必须阅读: 加载 references/evaluation_coordinator_runtime_contract.md、references/evaluation_summary_contract.md、references/evaluation_research_contract.md 必须阅读: 加载 references/audit_final_report_contract.md 必须阅读: 加载 references/research_tool_fallback.md 条件阅读:仅当来源可信度或声明不确定性影响问题验证时,才加载 references/epistemic_protocol.md。

目的

  • 审计文档结构、相关性、注释和事实准确性
  • 协调 ln-611、ln-612、ln-613、ln-614
  • 最终评分前,要求依据研究支持的标准

运行时契约

运行时系列:

  • evaluation-runtime

标识符:

  • docs-audit

阶段顺序:

  1. PHASE_0_CONFIG
  2. PHASE_1_DISCOVERY
  3. PHASE_2_RESEARCH
  4. PHASE_3_DELEGATE
  5. PHASE_4_AGGREGATE
  6. PHASE_5_REPORT
  7. PHASE_6_SELF_CHECK

工作器集合

  • ln-611-docs-structure-auditor
  • ln-612-semantic-content-auditor
  • ln-613-code-comments-auditor
  • ln-614-docs-fact-checker

工作器调用(必须)

宿主技能调用: 必须使用 Skill(skill: "...", args: "...") 进行委派。

  • Claude:严格按照所示调用 Skill 工具。
  • Codex:如果没有 Skill 工具,则在可用技能中找到指定技能,读取其 SKILL.md,将 args 作为 $ARGUMENTS,执行该技能工作流,然后携带其结果/产物返回此处。
  • 不得内联工作器逻辑,也不得在未执行目标技能的情况下将工作器标记为完成。

使用 Skill 工具委派工作器。不得在协调器中内联工作器逻辑。

TodoWrite 格式(必须):

  • Resolve audit scope and build manifest
  • Load project documentation tree
  • Run best-practice research
  • Delegate to domain audit workers
  • Aggregate worker findings
  • Generate final audit report and remediation plan
  • Verify cleanup and self-check

调用示例:

Skill(skill: "ln-611-docs-structure-auditor", args: "{scope}")
Skill(skill: "ln-612-semantic-content-auditor", args: "{scope}")
Skill(skill: "ln-613-code-comments-auditor", args: "{scope}")
Skill(skill: "ln-614-docs-fact-checker", args: "{scope}")

工作流

阶段 0:配置

以 required_research=true 启动 evaluation-runtime。

阶段 1:发现

发现文档范围和待审范围。

阶段 2:研究

必须使用以下研究来源:

  1. 官方文档或标准
  2. MCP Ref
  3. 涉及框架文档时使用 Context7
  4. 当前网络最佳实践研究
阶段 3:委派

委派专门的审计工作器。

子工作器必须使用 evaluation-worker-runtime,并生成兼容评估的摘要,通过 evaluation-runtime 记录。

阶段 4:汇总

将工作器摘要合并为一份文档审计结果。读取每个工作器的 report_path,规范化问题发现、去重重复问题,并根据 references/evaluation_research_contract.md 中的研究来源顺序验证每个可执行问题。

阶段 5:报告

根据 references/audit_final_report_contract.md 编写 .hex-skills/runtime-artifacts/runs/{run_id}/audit-report/ln-610--final-report.md。报告中须包含整改计划、每个已确认问题的来源支持验证,以及清理说明。合并后删除临时工作器 Markdown 报告。evaluation-coordinator 摘要的 report_path 必须仅指向最终报告。

阶段 6:自检

必须完成以下检查:

  • 已完成必要研究
  • 已记录所有工作器摘要
  • 已生成汇总摘要
  • 已编写最终整改报告
  • 已删除临时工作器 Markdown 报告
  • 已验证清理工作
  • 已记录协调器摘要

摘要契约

写入 summary_kind=evaluation-coordinator。

完成标准

  • 评估运行时已启动
  • 研究已完成
  • 所有文档审计工作器均已完成
  • 汇总已完成
  • 最终报告和修复计划已撰写
  • 临时工作器 Markdown 报告已移除
  • evaluation-coordinator 摘要已撰写
  • 运行时已完成

元分析

可选参考:仅当用户要求进行运行后元分析或按协议格式撰写运行反思时,才加载 references/meta_analysis_protocol.md。

在协调器运行后收到此类请求时,按照协议第 7 节分析会话,并将按协议格式编写的输出与最终文档审计结果一并提供。

参考资料

  • 工作器:../ln-611-docs-structure-auditor/SKILL.md、../ln-612-semantic-content-auditor/SKILL.md、../ln-613-code-comments-auditor/SKILL.md、../ln-614-docs-fact-checker/SKILL.md

版本: 5.0.0 最后更新: 2026-03-01

评论

支持 Markdown