Review of design documents points to note

1. Integrity: to find documents or incomplete in some places require special background knowledge. Normally the team no one will understand this knowledge, especially for newcomers. Document authors are encouraged to add more details in this regard, or add some links to external documents to supplement this part of the background.
2. Correctness: look for errors grammar, spelling, punctuation, etc., which is usually caused by careless, does not mean that the code they write future as well. But you can not break the rules for such errors.
3. Consistency: to ensure consistent description with pictures and text. Make sure the document does not appear with other documents diametrically opposed views and ideas.
4. Design: document some of the design to be well thought out. Considering the available resources, whether the target can be reached smoothly? What basis you want to use technology framework (Framework read and understand their deficiencies?) Desired design method used in the framework is correct? Whether the design is too complicated? It is possible to simplify it? Or too simple? This design also need to increase what?
5. Interfaces and protocols: Is there a clear definition of the protocol used in the document? Whether complete description of the product external interfaces and protocols? Whether to implement the interface protocol that is consistent with their expectations? For other GOOGLE products meets uniform standards? It is encourage developers to customize data format protocol buffer
6. Test: You can test the system or the entire system described in the documentation how? The need for additional test hook (in order to test and add some interface to display system internal state information), if needed, to ensure that they are also added into the document. Whether the design of the system taking into account the testability, and whom also made some adjustments? Can I use an existing test framework? Estimated at about the testing we all need to do what work, and this part of the contents of the document to be added to the design.