如何评审文档

1:完整性:
找出文档中残缺不全或一些地方需要特殊背景知识的地方。鼓励作者在这这些方面添加更多细节。
2:正确性:
看一下是否有语法,拼写,标点符号等错误。
这一般是马虎大意造成的,并不意味着他们以后编写的代码也是这样。
3:一致性:
确保配图和文字描述一致,确保文档中没有出现与其他文档中截然相反的观点和主张。
4设计:文档中的设计要经过深思熟悉,考虑到可用的资源,目标是否可以顺利到达。要使用何种基础的技术框架(读一读框架文档并了解他们的不足)期望的设计中框架方面是否正确?设计师否太过复杂,有可能简化么?还是太简单了。这个设计还需要增加什么协议.

接口与协议:文档中是否对所使用的协议有清晰的定义,是否完整的描述了产品对外的接口与协议,这些接口协议的实现是否与他们期望的那样一致,对于其他的google产品是否满足统一的标准。是否鼓励开发人员自定义数据格式。
测试:系统或文档中描述的整套系统的可测试性怎么样?是否需要新增测试钩子。
如果需要,确保他们也被添加到文档之中,

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值