| name | review-lesson |
| description | 审查课程代码的教学质量和正确性。当用户要求审查、检查、改进某个课程文件时使用。例如"检查一下 Go 并发这一章的质量"、"review goroutines 课程"。 |
| argument-hint | <文件路径或模块目录> |
| allowed-tools | Read, Glob, Grep, Bash |
| context | fork |
| agent | general-purpose |
审查课程质量
对指定的课程文件进行全面的教学质量审查。
参数
$ARGUMENTS — 文件路径或目录路径,例如:
Go/04-concurrency/01_goroutines.go
Go/04-concurrency/(审查整个子目录)
Python/(审查整个模块)
审查维度
1. 代码正确性
- 代码是否可以编译/运行
- 是否有语法错误或逻辑错误
- 变量命名是否规范
2. 教学质量
- 注释是否充分、准确
- 是否从简单到复杂递进
- 是否解释了"为什么"而不只是"是什么"
- 是否涵盖常见陷阱和最佳实践
- 示例是否有实际意义(不是无意义的 foo/bar)
3. 风格一致性
- 是否使用中文注释
- 是否使用标准分隔符格式(
==== 和 ----)
- 文件头部是否有主题概述
- 是否遵循
XX_name.ext 命名约定
4. 内容完整性
- 该主题的核心概念是否全部覆盖
- 是否缺少重要的使用场景
- 是否有遗漏的边界情况
5. 知识准确性
- 技术描述是否准确
- 是否有过时的信息或已废弃的 API
- 最佳实践是否符合当前社区共识
输出格式
对每个审查的文件,输出:
## <文件路径>
**总体评分**: ⭐⭐⭐⭐ (4/5)
### ✅ 优点
- ...
### ⚠️ 建议改进
- [行号] 具体问题描述和改进建议
### ❌ 必须修复
- [行号] 具体错误描述
最后给出整体总结和优先改进建议。