用途:在提交 PR 前审查文档改动,判断变更是否正确、完整地解决既定问题,且不引入新问题。资料强调应从零假设出发,主动发现作者遗漏之处。
主要流程与能力:
- 确定审查范围:未提交改动用 git diff --name-only;上次提交用 git diff --name-only HEAD~1;整个分支对比 main 用 git diff --name-only main...HEAD。
- 完整阅读每个改动文件,而不只看 diff,以理解页面整体上下文;再按对应比较方式查看带上下文的差异,如 git diff --unified=10、git diff --unified=10 HEAD~1、git diff --unified=10 main...HEAD。
- 追踪交叉引用:搜索引用改动内容的页面、标题锚点或关键词,阅读被链接页面,确认不产生跨页矛盾,并检查锚点链接是否仍匹配标题 ID。
- 核实事实准确性:对照上游文档或源码验证功能行为描述;检查 URL 是否可解析;确认 CLI 标志、选项或 API 字段是否存在。
- 以读者视角评估:页面能否独立理解,改动部分在未读 issue 或 diff 时是否清晰,是否会让读者困惑。
- 审查代码与模板改动:对 JS、HTML、CSS、Hugo 模板等非 Markdown 变更,追踪常见执行路径和至少一个边界情况(如无存储偏好、Alpine 加载失败、首次访问与回访),判断是否可能产生自动化工具无法捕获的浏览器或运行时异常。
- 决策:正确、连贯、完整且事实准确则批准;未正确解决问题、存在事实错误或矛盾、交叉引用损坏或误导、读者会困惑时要求修改。要求修改需具体引用错误文本、说明原因并建议正确修复。
限制:资料未提供该技能的安装方式、收费、平台或价格信息,暂未提供。