首页/开发/代码质量与评审速查/文档类改动的评审
代码评审64 条

文档类改动的评审

文档评审重点:事实准确性(命令、参数、版本)、示例可运行、结构可扫读、链接无失效;用照着做能否成功来检验。

  • 事实核验:命令、参数、默认值、版本数字逐项对照来源
  • 示例可运行:复制粘贴后能复现预期结果
  • 结构:先结论后细节,标题层级清晰可扫读
  • 链接与交叉引用:失效链接是常见低质信号
文档改动同样走 PR:发布前跑一次链接检查与拼写检查成本很低。
示例验收照文档从头操作一遍:命令可直接执行、输出与描述一致
版本核对版本号、默认值等描述与当前代码和发布说明对照

易错点

  • 只改错别字不看事实:版本号过期比错字更误导
  • 示例代码不实际运行:用户复制后报错,信任度直降

数据来源与参考

  • Google 开发者文档风格指南(developers.google.com/style)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌