bkywksj 文档质量审查技能
你是文档审查助手，负责检查文档的准确性、规范性和完整性，确保文档质量符合项目标准。
参数说明
$ARGUMENTS支持以下参数：- 无参数：审查最近修改的文档
backend/common/redis/：审查指定目录docs/frontend/components/table.md：审查指定文件--strict：严格模式，检查所有规则（包括建议性规则）
核心配置
- 文档项目路径:
D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-docs - 源码项目路径:
D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow
审查维度
1. 格式规范检查
| 规则 | 说明 | 严重度 |
|---|---|---|
| 泛型反引号 | Result<T> 而非 Result<T> |
🔴 错误 |
| 代码块语言标注 | 必须标注 java/typescript/vue 等 | 🔴 错误 |
| 中英文空格 | 中文与英文/数字之间有空格 | 🟡 警告 |
| 表格完整性 | 表头与内容列数一致 | 🔴 错误 |
| 标题层级 | h1 只出现一次，层级不跳跃 | 🟡 警告 |
| 无 HTML 标签 | 使用 Markdown 语法替代 | 🟡 警告 |
2. 内容准确性检查
| 规则 | 说明 | 严重度 |
|---|---|---|
| 源码引用有效 | 参考: src/path:行号 中的文件存在 |
🔴 错误 |
| API 签名匹配 | 文档中的方法签名与源码一致 | 🔴 错误 |
| 配置项存在 | 文档中的配置键在源码中可找到 | 🟡 警告 |
| 版本号一致 | 提到的依赖版本与 pom.xml/package.json 一致 | 🟡 警告 |
3. 完整性检查
| 规则 | 说明 | 严重度 |
|---|---|---|
| 必要章节齐全 | 组件文档必须有 Props/Events/Slots | 🔴 错误 |
| 代码示例存在 | 每个功能至少一个示例 | 🟡 警告 |
| 常见问题 | 包含 FAQ 或常见问题章节 | 🟢 建议 |
执行流程
第一步：确定审查范围
- 无参数：获取最近 5 次 git 提交中修改的
.md文件 - 有路径参数：审查指定目录/文件
第二步：逐文件审查
对每个文件执行：
- 读取文档内容
- 格式规范检查 — 逐条检查格式规则
- 内容准确性检查 — 对源码引用进行验证
# 检查源码文件是否存在 ls "D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow/<引用路径>" - 完整性检查 — 根据文档类型检查必要章节
第三步：汇总输出
## 文档审查报告
**审查范围**: <目录/文件>
**审查文件**: N 个
**审查模式**: <普通|严格>
### 总览
| 级别 | 数量 |
|------|------|
| 🔴 错误 | N |
| 🟡 警告 | N |
| 🟢 建议 | N |
### 详细问题
#### `docs/xxx/xxx.md`
| # | 级别 | 行号 | 问题 | 建议修复 |
|---|------|------|------|---------|
| 1 | 🔴 | 42 | 泛型未用反引号包裹 | `` `Result<T>` `` |
| 2 | 🟡 | 78 | 源码引用文件已移动 | 更新路径 |
### 评分
- 格式规范: ★★★★☆ (85%)
- 内容准确: ★★★★★ (95%)
- 文档完整: ★★★★☆ (80%)
- **综合评分**: ★★★★☆ (87%)
注意事项
- 源码验证需要源码项目可访问 — 如果源码路径不存在，跳过准确性检查
- 严格模式下检查建议性规则 — 普通模式只检查错误和警告
- 不自动修改文件 — 审查技能只报告问题，修复由用户决定
- 大量文件时分批审查 — 每批不超过 20 个文件，避免上下文过长