GEO GUIDE
技术文档评审的检查清单
更新于 2026-10-19 · 本文不承诺任何搜索或引用结果
直接结论：文档评审查四个维度——准确性（与实际行为一致）、完整性（新用户能否独立完成一次成功使用）、结构（可导航可搜索）、时效（与最新版本同步）。每个维度给出具体检查项；不通过的项按维度记录，修复责任落到人。
直接结论：文档评审查四个维度——准确性（与实际行为一致）、完整性（新用户能否独立完成一次成功使用）、结构（可导航可搜索）、时效（与最新版本同步）。每个维度给出具体检查项；不通过的项按维度记录，修复责任落到人。
准确性
- 每个命令在干净环境中执行过并得到文档所述结果。
- 参数、默认值、返回值与当前版本一致。
- 示例代码可运行、输出与文档一致。
完整性
- 新用户能只靠文档完成一次成功使用。
- 前置条件（依赖、权限、版本）在开始处列明。
- 错误场景有处理指引（不只是成功路径）。
结构与时效
- 目录反映内容结构；可搜索。
- 与最新版本同步——过时的文档比没有文档更糟（读者会照着做）。
- 每页有明确的受众与前置知识说明。