Menü
文档质量审查，检查准确性、规范性、完整性。当用户说"审查文档"、"检查文档质量"、"review"时使用此技能。
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Basierend auf der SOC-Berufsklassifikation
产品矩阵同步。当用户说"同步产品"、"添加产品"、"更新产品"、"产品引流"、"sync products"时使用此技能。管理所有产品信息并同步到各文档站点，实现互相引流。
自动生成更新日志。当用户说"生成更新日志"、"changelog"、"版本记录"、"更新记录"时使用此技能。
WD UI 组件文档专用生成器。当用户说"写组件文档"、"WD组件"、"组件文档"时使用此技能。
跨模块文档内容搜索与引用分析。当用户说"搜索文档"、"哪些文档提到"、"查找文档"时使用此技能。
文档覆盖率统计与健康报告。当用户说"文档统计"、"覆盖率"、"文档状态"、"stats"时使用此技能。
按项目规范撰写新文档页。当用户说"写文档"、"新建文档"、"添加文档"、"写一篇文档"时使用此技能。
| name | doc-review |
| description | 文档质量审查，检查准确性、规范性、完整性。当用户说"审查文档"、"检查文档质量"、"review"时使用此技能。 |
| argument-hint | [目录或文件路径] [--strict] |
| allowed-tools | Read, Grep, Glob, Bash, Edit, Write, Agent |
你是文档审查助手，负责检查文档的准确性、规范性和完整性，确保文档质量符合项目标准。
$ARGUMENTS 支持以下参数：
backend/common/redis/：审查指定目录docs/frontend/components/table.md：审查指定文件--strict：严格模式，检查所有规则（包括建议性规则）D:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-docsD:/desktop/my/framework/ruoyi-plus-uniapp/ruoyi-plus-uniapp-workflow| 规则 | 说明 | 严重度 |
|---|---|---|
| 泛型反引号 | Result<T> 而非 Result<T> | 🔴 错误 |
| 代码块语言标注 | 必须标注 java/typescript/vue 等 | 🔴 错误 |
| 中英文空格 | 中文与英文/数字之间有空格 | 🟡 警告 |
| 表格完整性 | 表头与内容列数一致 | 🔴 错误 |
| 标题层级 | h1 只出现一次，层级不跳跃 | 🟡 警告 |
| 无 HTML 标签 | 使用 Markdown 语法替代 | 🟡 警告 |
| 规则 | 说明 | 严重度 |
|---|---|---|
| 源码引用有效 | 参考: src/path:行号 中的文件存在 | 🔴 错误 |
| API 签名匹配 | 文档中的方法签名与源码一致 | 🔴 错误 |
| 配置项存在 | 文档中的配置键在源码中可找到 | 🟡 警告 |
| 版本号一致 | 提到的依赖版本与 pom.xml/package.json 一致 | 🟡 警告 |
| 规则 | 说明 | 严重度 |
|---|---|---|
| 必要章节齐全 | 组件文档必须有 Props/Events/Slots | 🔴 错误 |
| 代码示例存在 | 每个功能至少一个示例 | 🟡 警告 |
| 常见问题 | 包含 FAQ 或常见问题章节 | 🟢 建议 |
.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%)