Content comes from: http://blog.slickedit.com/2007/05/how-to-write-an-effective-design-document/
第一部分:阐述你的工程需要解决什么问题,目标的用户是谁。同时,通过写这个部分,你可以知道你的目标工程是否合理且有存在的意义。
第二部分:从high level去阐述这个工程的构成部分有哪些,简要介绍他们的功能。这里需要用到entity diagram去阐述。例如:
第三部分:详细地介绍每个模块的内容。如果这个模块是某个接口的实现类,就可以在这里详细叙述。
通常需要叙述的内容:1/ 用一段介绍其usage,不需要be verbose. 2/ 是否有什么special configuration,这里可以讲述下一些特殊的函数参数的作用。 3/ 用类UML去介绍下这个模块的类族。
例如:
第四部分:Interaction Diagram. 当前模块之间的通信图。例如:
第五部分:阐述下总体的benefit 和 risk.