跳到正文

审阅反馈示例

用具体位置、读者影响、修改建议和验收方式表达审阅意见。

给每条意见可定位的上下文

评论从出现问题的一句正文、字段或示例开始。说明对应的读者结果,再给出可以验证的调整。需要前后文时,引用同一个页面的小节名或带版本的证据。

笼统的评论可以采取的反馈
这里不够清楚。此处的“它”可能指构建器或浏览器。请写出“浏览器加载索引文件”,使读者知道要在哪里检查请求。
这个参数写错了。参考页写的上限是 50,2.2 版类型定义和测试约定为 100。请核对目标版本后更新表格和示例。
链接打不开。这个链接的路径有效,标题锚点已随重命名改变。请从预览页复制当前标题链接,再从此处打开确认。

标明影响和复查方式

会让操作失败、让读者用到错误版本或改变技术含义的事项,明确写出应在本次改动中解决的原因。措辞建议可以给出具体改写。无法确认某段实现时,写出已经查看的来源、还缺少的依据和要确认的问题。

例如,“语言说明写成‘必须重启’,但只有更改运行时配置才需要重启。请用条件句的写法标出对应设置,并验证一次仅修改构建配置的路径。”

回应后确认实际修改

重读修订差异及相关页面。检查反馈中的命令和预期结果是否匹配。译文有意义变化时复查同版本原文,并请熟悉目标语言的人确认读者阅读体验。跟进流程可按审阅和合并记录。