检查内容与步骤
- 标题、摘要和前置条件交代了读者的任务、适用版本和环境。
- 关键行为和默认值与代码或上游参考一致。
- 按文中的顺序执行命令可以得到说明中的结果。
- 涉及权限、数据或兼容性的影响在操作之前交代。
- 用实际输入和输出验证新增或修改的示例。
检查写法与页面
- 术语、产品名和代码标识符拼写统一,正文遵循中文排版。
- 链接加在句中能说明目标的关键词上,站内链接与锚点可以打开。
- 标题层级、列表、表格和代码块按预期渲染。
- 窄屏可以阅读正文和表格,插图提供了有用的替代文本。
按变更内容增加检查
| 本次改动 | 要确认的结果 |
|---|---|
| 翻译 | 已查看同版本原文,条件、数值、单位和术语一致 |
| API 或配置 | 已执行典型和边界输入,默认值、错误及生效时机已记录 |
| 页面移动 | 已打开旧链接、新导航和标题锚点,确认进入预期版本 |
| 升级 | 已覆盖受影响的起始状态,迁移后有可观察的结果 |
| 新组件 | 文本可阅读,常用键盘操作、复制或媒体替代内容可用 |
可按质量检查工具选择格式、构建和预览命令,并在 PR 中注明实际运行结果。
给出可执行的意见
指向出现问题的行或段落,说明读者会受到什么影响,再给出可以验证的改法。将技术错误和会卡住任务的问题优先提出。措辞细节可以附上改写,便于贡献者判断是否采纳。