Recommend for Reviewing design doc-from How Google Test Software

Below paragraph is from <How Google Test Software>, I do think it‘s a good reference for us. Some rules also can be applied for other document review, for example, on specifications.

“Reviewing design documents should be done with purpose and not just

be a general breeze through, as though you are reading a newspaper. A good
SET is purposeful during his review. Here are some things we recommend:

• Completeness: Identify parts of the document that are incomplete or
that require special knowledge not generally available on the team, particularly
to new members of the team. Encourage the document’s
author to write more details or link to other documentation that fill in
these gaps.

Correctness: Look for grammar, spelling, and punctuation mistakes;
this is sloppy work that does not bode well for the code they will write
later. Don’t set a precedent for sloppiness.

Consistency: Ensure that wording matches diagrams. Ensure that the
document does not contradict claims made in other documents.

Design: Consider the design proposed by the document. Is it achievable
given the resources available? What infrastructure does it propose
to build upon? (Read the documentation of that infrastructure and
learn its pitfalls.) Does the proposed design make use of that infrastructure
in a supported way? Is the design too complex? Is it possible to
simplify? Is it too simple? What more does the design need to address?

• Interfaces and protocols: Does the document clearly identify the protocols
it will use? Does it completely describe the interfaces and protocols
that the product will expose? Do these interfaces and protocols accomplish
what they are meant to accomplish? Are they standard across
other Google products? Can you encourage the developer to go one
step further and define his protocol buffers? (We discuss more about
protocol buffers later.)


• Testing:
How testable is the system or set of systems described by the
document? Are new testing hooks required? If so, ensure those get
added to the documentation. Can the design of the system be tweaked
to make testing easier or use pre-existing test infrastructure? Estimate
what must be done to test the system and work with the developer to
have this information added to the design document.”

时间: 2024-11-10 08:21:37

Recommend for Reviewing design doc-from How Google Test Software的相关文章

《How Google Test Software》阅读体会

How Google Test Software 之 软件测试开发工程师 本文是课程<软件测试>的项目之一:Project #1: Reading a book,来自小组:Developer is tester 成员:吴家荣 景 涛 陈兆鹏 郭路文 梁华淇 何金岳 展示PPT:http://slides.com/wujiarong/deck-1#/ Part 1: Summary of content 全书总分为三个部分,五个章节 第一部分:简单介绍了Google软件测试的概念,角色,组织机构

Learning JavaScript Design Patterns -- A book by Addy Osmani

Learning JavaScript Design Patterns A book by Addy Osmani Volume 1.6.2 Tweet Copyright © Addy Osmani 2015. Learning JavaScript Design Patterns is released under a Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 unported license. It

Android Design 与 Holo Theme

转载:http://www.geekpark.net/topics/179488 [核心提示] 提到 Android Design,很多人会做出”啊,知道,就是黑色的背景和灰蓝色的平的按钮嘛”,那么到底什么是 Android Design 什么是 Holo Theme,它们的关系是什么?本质又是什么? 在国内,有个很有意思的现状.一方面,几个国内最大的公司/企业的客户端/应用依旧冥顽不灵,丝毫不愿意遵循 Android Design,以各种扯淡的理由坚持使用 iOS UI 或者 Metro UI

2014 I/O归来:Google连接一切

6月,WWDC 2014与Google I/O  (大部分演讲视频都公开,Youtube需要翻墙,非常值得一看)相继召开.今年是我第三年参加Google I/O大会.三年间,Google积累了很多技术.做出了很多产品.本届Google I/O大会,Google向世界展示了一幅场景:Google正在连接一切. 20世纪80年代末,美国Xerox公司PARC研究中心的Mark Weiser提出了普适计算(Ubiquitous computing)的概念.在普适计算的模式下,人们能够在任何时间.任何地

Android Design Support Library 使用详解

概述 Android Design Support Library 是Google在2015年的IO大会上,带来的全新适应Material Design设计规范的支持库.在这个支持库中,给我们提供了更加规范的MD设计风格控件.重要的是,Android Design Support Library中,支持所有的Android 2.1以上版本系统.在这个支持库中,主要包含下面几大控件: Snackbar,FloatingActionButton,TextInputLayout,TabLayout,A

一大波Material Design干货来袭

什么是Material Design 据谷歌介绍,Material Design基于"真实的触感,灵感源自对纸和墨水的研究," 能够让用户 "理解那些用于替代真实世界的可视线索,""而又不违背力学原理."另外,光线.表面和移动的基本原理是表现对象如何移动.交互和相互关联地存在于空间中的关键.逼真的光影效果可以显示区块间的接缝.划分空间.以及标识移动的部件. Material Design在动画.风格和布局方面提出了一系列的原则,并且为大量的视觉组

Android Material Design之Toolbar与Palette

转:http://blog.csdn.net/jdsjlzx/article/details/41441083 前言 我们都知道Marterial Design是Google推出的全新UI设计规范,如果对其不太了解的可以看下:Material design非官方中文指导手册 ,或者我的前面几篇Material Design的译文,相比之前Google在Android Holo风格上平平淡淡的表现不同,Material Design现在是被Google所比较重视的.在推出这门全新设计语言后,And

Android Design与Holo Theme详解

在 国内,有个很有意思的现状.一方面,几个国内最大的公司/企业的客户端/应用依旧冥顽不灵,丝毫不愿意遵循 Android Design,以各种扯淡的理由坚持使用 iOS UI 或者 Metro UI,或者其他叫不出名字的 UI:另一方面,Holo Theme 作为 Android Design 的一部分,渐渐为更多的用户和开发者所知晓.很多个人开发者都开始在 Play Store 和国内各大市场发布较为简陋但符合 Android Design 的应用. 什 么是 Android Design?

2014 I/O返回:Google连接一切

文/蒋涛 6月.WWDC 2014与Google I/O  (大部分演讲视频都公开.Youtube须要FQ.很值得一看)相继召开. 今年是我第三年參加Google I/O大会.三年间,Google积累了许多技术.做出了许多产品.本届Google I/O大会.Google向世界展示了一幅场景:Google正在连接一切. 20世纪80年代末,美国Xerox公司PARC研究中心的Mark Weiser提出了普适计算(Ubiquitous computing)的概念. 在普适计算的模式下,人们能够在不论