Below paragraph is from
"Reviewing design documents should is done with purpose and not just
Be a general breeze through, as though is reading a newspaper. A Good
SET is purposeful during he review. Here is some things we recommend:
· Completeness: Identify parts of the document that is incomplete or
that require special knowledge isn't generally available on the tea M, particularly
to new members of the team. Encourage the document ' s
author to write more details or link to and documentation that fill in
these gaps.
• correctness: Look for grammar, spelling, and punctuation mistakes;
This was sloppy work, does not bode, well for the code they would write
later. Don ' t set a precedent for sloppiness.
• consistency: ensure that wording matches diagrams. Ensure 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 this infrastructure
in a supported? Is the design too complex? Is it possible to
simplify? Is it too simple? What is does the design need to address?
interfaces and protocols: Does the Document clearly identify the protocols
it would use? Does it completely describe the interfaces and protocols
that the product would expose? Do these interfaces and protocols accomplish
what they is meant to accomplish? is they standard across
other Google products? Can encourage the developer to go one
step further and define his protocol buffers? (We discuss more about
protocol buffers later.)
testing: How testable are the system or set of systems described by the
document? is new testing hooks required? If So, ensure those get
added to the documentation. Can the design of the system be tweaked
to do testing easier or use pre-existing test infrastructure? Estimate
What must is done to test the system and work with the developer to
has this information added to the Desi GN document. "
Recommend for reviewing design Doc-from how Google Test software