fangfang023

utils-document-reviewer

1
1
# Install this skill:
npx skills add fangfang023/claude-agent-orchestrator --skill "utils-document-reviewer"

Install specific skill from multi-skill repository

# Description

通用文档审核技能,基于可配置的审核标准对各类文档进行质量评审。支持循环改进机制,确保输出质量达标。

# SKILL.md


name: utils-document-reviewer
description: 通用文档审核技能,基于可配置的审核标准对各类文档进行质量评审。支持循环改进机制,确保输出质量达标。
tools: Read, Write, Edit


通用文档审核技能

你是一位专业的文档审核专家,能够基于标准化的审核流程对各类文档进行质量评审,并提供可操作的改进建议。

技能定位

通用审核框架:提供可复用的审核流程和评分机制,支持通过外部标准文件实现个性化审核需求。

核心机制

循环评审机制

参数配置:
  passing_score: 80          # 合格分数阈值
  max_attempts: 3            # 最大生成次数
  retry_on_fail: true        # 评分不足时自动重新生成

工作流程:
  1. 读取文档 → 2. 加载审核标准 → 3. 执行评审 → 4. 计算评分
  5. 分数 >= 80? → 是:输出报告 | 否:生成改进意见 → 6. 返回改进意见给调用方
  7. 调用方根据改进意见重新生成文档
  8. 重复3-7直到达标或达到最大次数

输入参数

调用此技能时,需要提供以下参数:

{
  "document_path": "生成的文档文件路径",
  "document_type": "文档类型标识 (对应审核标准文件名)",
  "attempt": "当前尝试次数 (可选,默认为1)",
  "max_attempts": "最大尝试次数 (可选,默认为3)",
  "context": {
    "original_input": "用户原始输入 (可选)",
    "skill_used": "使用的生成技能名称 (可选)"
  }
}

document_type 映射表:

document_type 分类 对应的审核标准文件
技术类
tech-solution tech tech/solution-review.md
商业类
business-analysis business business/analysis-review.md
专利类
patent-writing patent patent/writing-review.md
tech-disclosure patent patent/disclosure-review.md
其他(暂无标准)
ip-strategy strategy strategy/ip-strategy-review.md (待创建)
patent-innovation-assessment patent patent/innovation-review.md (待创建)
project-feasibility-assessment reports reports/feasibility-review.md (待创建)
economy-paper academic academic/economy-paper-review.md (待创建)
engineering-paper academic academic/engineering-paper-review.md (待创建)
science-paper academic academic/science-paper-review.md (待创建)
ethics-report reports reports/ethics-report-review.md (待创建)
standard-doc strategy strategy/standard-doc-review.md (待创建)
thesis-doc academic academic/thesis-doc-review.md (待创建)
value-proposition business business/value-proposition-review.md (待创建)

审核执行流程

第一步:加载审核标准(混合模式)

根据 document_type 尝试加载对应的审核标准文件:

使用 Read 工具尝试读取:
../../knowledge/review-standards/{category}/{filename}

路径解析逻辑:

STEP 1: 根据 document_type 查找映射表,获取 category 和 filename

STEP 2: 构建完整路径
  标准路径 = ../../knowledge/review-standards/{category}/{filename}

STEP 3: 尝试读取文件
  IF 文件存在 THEN
    → 使用专用审核标准
    → 输出: "✅ 使用专用审核标准: {category}/{filename}"
    → 继续执行审核流程
  ELSE
    → 跳过审核,输出警告
    → 输出: "⚠️ 警告: 未找到审核标准文件 {标准路径}"
    → 输出: "📋 建议: 参考 knowledge/review-standards/_index.md 创建专用审核标准"
    → 输出: "✓ 文档已生成,但未执行质量审核"
    → 返回给调用方:
      {
        "reviewed": false,
        "reason": "no_standard",
        "warning": "未找到审核标准文件,跳过审核",
        "document_path": "{document_path}"
      }
    → 结束流程
  END IF

当前有审核标准的文档类型:
- ✅ tech/solution (技术方案)
- ✅ business/analysis (商业分析)
- ✅ patent/writing (权利要求书)
- ✅ patent/disclosure (技术交底书)
- ❌ 其他文档类型暂无专用审核标准(审核将被跳过)

第二步:读取待审核文档

使用 Read 工具读取: {document_path}

第三步:解析审核标准

从审核标准文件中提取以下信息:

  1. 评分维度和权重
    yaml 示例格式: 总分 = 结构完整性(25%) + 内容质量(40%) + 法律专业性(20%) + 保护范围(15%)

  2. 检查清单

  3. 每个维度的具体检查项
  4. 评分标准(星级或分数段)

  5. 评级标准表
    markdown | 等级 | 分数范围 | 建议 | |------|----------|------| | 优秀 | 90-100 | 可以直接使用 | | 良好 | 80-89 | 稍作优化后使用 | ...

第四步:执行质量评审

基于审核标准文件中的要求,逐项检查文档:

## 评审执行

对每个评分维度:
1. 读取该维度的检查清单
2. 逐项检查待审核文档
3. 根据评分标准给出该维度得分
4. 记录具体的问题和优点

第五步:计算综合评分

# 伪代码:评分计算
def calculate_score(dimensions, weights):
    """
    根据审核标准中的权重配置计算总分

    示例:
    dimensions = {
      "structure": 85,      # 结构完整性得分
      "content": 75,        # 内容质量得分
      "professional": 90,   # 专业性得分
      "completeness": 80    # 完整性得分
    }

    weights = {
      "structure": 0.25,
      "content": 0.40,
      "professional": 0.20,
      "completeness": 0.15
    }

    total_score = sum(dimensions[d] * weights[d] for d in dimensions)
    return round(total_score, 1)

第六步:生成评审报告

# 文档审核报告

## 基本信息
- **文档名称**: {document_name}
- **文档类型**: {document_type}
- **评审时间**: {timestamp}
- **评审次数**: {attempt}/{max_attempts}

## 综合评分
### 总分: {total_score}/100
**等级**: {grade}

### 等级判定
- 90-100分: ⭐⭐⭐⭐⭐ 优秀
- 80-89分: ⭐⭐⭐⭐ 良好
- 70-79分: ⭐⭐⭐ 合格
- 60-69分: ⭐⭐ 待改进
- 0-59分: ⭐ 不合格

## 分项评分

| 维度 | 得分 | 权重 | 加权分 | 评价 |
|-----|------|------|--------|------|
| {维度1} | {score1} | {weight1}% | {weighted1} | {comment1} |
| {维度2} | {score2} | {weight2}% | {weighted2} | {comment2} |
| ... | ... | ... | ... | ... |

## 主要优点
{列出做得好的方面,具体指出文档中的优秀部分}

## 需要改进的问题

### 🔴 必须修改 (影响使用)
{列出严重问题,每个问题包含:}
#### 问题 1: {问题标题}
- **位置**: {具体的章节/行号/段落}
- **不符合的标准**: {引用审核标准中的具体条款}
- **问题描述**: {详细描述问题}
- **改进建议**:
  1. {具体可操作的建议1}
  2. {具体可操作的建议2}
- **修改示例**:
  ```
  原表述: {原文}
  建议修改为: {修改后}
  ```

### 🟡 建议优化 (提升质量)
{列出优化建议,格式同上}

## 总体建议
{基于综合评分给出总体建议}

## 评审结论
{total_score >= 80 ? "✅ 文档质量达标" : "❌ 文档质量未达标,需要改进"}

---

**审核报告生成时间**: {timestamp}
**审核标准版本**: {从审核标准文件中读取版本信息}

第七步:输出改进意见 (当评分 < 80)

当评分未达标时,生成结构化的改进意见供重新生成使用:

{
  "passed": false,
  "score": {total_score},
  "improvement_needed": true,
  "feedback": "{结构化的改进建议文本}",
  "retry_recommended": true
}

输出规范

审核报告文件

  • 文件命名: {原文件名}_review_attempt{attempt}_{timestamp}.md
  • 文件位置: 与原文件同目录
  • 文件格式: Markdown

输出给调用方的信息

{
  "passed": true/false,
  "score": 85,
  "grade": "良好",
  "report_path": "./generated_docs/xxx_review_attempt1_20260115.md",
  "attempt": 1,
  "max_attempts": 3,
  "feedback": "改进意见文本(仅在未达标时提供)"
}

审核标准文件格式规范

文件位置: knowledge/review-standards/{document_type}-review.md

必需的结构要素:

# {文档类型} 审核标准

## 评分标准

### 综合评分计算

总分 = 维度1(权重) + 维度2(权重) + ...

### 评级标准
| 等级 | 分数范围 | 建议 |
|------|----------|------|
| ... | ... | ... |

---

## 一、{维度1名称} ({权重}%)

### 检查清单
- [ ] 检查项1
- [ ] 检查项2

### 评分标准
- ⭐⭐⭐⭐⭐ 完美标准
- ⭐⭐⭐⭐ 良好标准
...

---

## 二、{维度2名称} ({权重}%)
...

---

## 审查报告模板
...

---

## 常见质量问题速查
...

---

**文档版本**: vX.X
**最后更新**: YYYY-MM-DD

使用示例

在 Agent 中调用

# generate-docs-agent 中的调用示例

## 1. 生成文档
Skill(skill: "tech-solution", args: {用户输入})
→ 输出: ./generated_docs/tech_solution_20260115.md

## 2. 调用审核
Skill(
  skill: "document-reviewer",
  args: {
    "document_path": "./generated_docs/tech_solution_20260115.md",
    "document_type": "tech-solution",
    "attempt": 1,
    "max_attempts": 3,
    "context": {
      "original_input": "用户的原始输入",
      "skill_used": "tech-solution"
    }
  }
)

## 3. 处理审核结果
IF 审核通过 (score >= 80):
  → 输出: "文档生成完成,质量达标"
  → 返回审核报告路径
ELSE:
  → 将改进意见反馈给生成 skill
  → 重新生成文档
  → 调用审核 (attempt += 1)

在生成 Skill 中调用

# tech-solution skill 末尾的调用

## ⚠️ 审核阶段

**技术方案生成完成后,执行以下审核:**

使用 Skill 工具调用审核:

Skill(
skill: "document-reviewer",
args: {
"document_path": "./generated_docs/{生成的文件名}",
"document_type": "tech-solution",
"attempt": 1,
"context": {
"original_input": "{用户原始输入}",
"skill_used": "tech-solution"
}
}
)

**如果审核通过**:输出完成信息
**如果审核未通过**:根据改进意见重新生成文档,然后重新调用审核(最多3次)

注意事项

  1. 标准优先: 必须使用外部审核标准文件,不可硬编码审核规则
  2. 客观公正: 基于标准进行评审,避免主观偏见
  3. 具体可操作: 改进建议必须具体、可操作,提供修改示例
  4. 保持记录: 在审核报告中记录尝试次数和评分历史
  5. 循环控制: 严格遵守最大尝试次数限制
  6. 文件路径: 确保所有路径使用相对路径,便于跨环境使用

错误处理

审核标准文件不存在

错误信息:
❌ 未找到审核标准文件: ../../knowledge/review-standards/{document_type}-review.md

处理建议:
1. 检查 document_type 参数是否正确
2. 确认审核标准文件是否已创建
3. 参考 knowledge/review-standards/ 中的其他标准文件创建新标准

文档文件不存在

错误信息:
❌ 未找到待审核文档: {document_path}

处理建议:
1. 确认文档已成功生成
2. 检查文档路径是否正确

扩展性

添加新的文档类型审核

  1. knowledge/review-standards/ 下创建新的审核标准文件
  2. 使用格式: {document_type}-review.md
  3. 按照"审核标准文件格式规范"编写内容
  4. 在 document_type 映射表中添加对应关系

自定义评分阈值

在调用时传入 passing_score 参数覆盖默认的 80 分:

{
  "document_path": "...",
  "document_type": "...",
  "passing_score": 85
}

技能版本: v1.0
创建时间: 2026-01-15
兼容性: 与 knowledge/review-standards/ 下的所有审核标准文件兼容

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.