审阅设计文档注意要点

1. 完整性：找出文档中残缺不全或一些需要特殊背景知识的地方。通常情况下团队里没人会了解这些知识，特别是对新人而言。鼓励文档作者在这方面添加更多细节，或增加一些外部文档链接，用以补充这部分背景知识。
2. 正确性：看一下是否有语法、拼写、标点符号等方面的错误，这一般是马虎大意造成的，并不意味着他们以后编写的代码也是这样。但也不能为这种错误而破坏规矩。
3. 一致性：确保配图和文字描述一致。确保文档中没有出现与其他文档中截然相反的观点和主张。
4. 设计：文档中的一些设计要经过深思熟虑。考虑可用到的资源，目标是否可以顺利达成？要使用何种基础的技术框架（读一读框架并了解他们的不足？）期望的设计在框架方面使用方法是否正确？设计是否太过复杂？有可能简化吗？还是太简单了？这个设计还需要增加什么内容？
5. 接口和协议：文档中是否对所使用的协议有清晰的定义？是否完整地描述了产品对外的接口与协议？这些接口协议的实现是否与他们期望的那样一致？对于其他的GOOGLE产品是否满足统一的标准？是否鼓励开发人员自定义protocol buffer数据格式
6. 测试：系统或文档中描述的整套系统的可测试性怎样？是否需要新增测试钩子（为了测试而增加一些接口，用以显示系统内部状态信息），如果需要，确保他们也被添加到文档之中。系统的设计是否考虑到易测试性，而为之也做了一些调整？是否可以使用已有的测试框架？预估一下在测试方面我们都需要做哪些工作，并把这部分内容也增加到设计文档中去。

审阅设计文档注意要点

原文：https://www.cnblogs.com/nlry901/p/11444750.html