关于设计和设计文档的2个补充

曾迷惑于什么是设计，设计文档应该要多详细, 具体可见之前的随笔：想探讨两个关于设计文档问题

和大家讨论过一番后还是不得要领。最近读了下面2段内容，颇有感受，遂载录之：

In the pages that follow, we will often talk about "The Design." You should not take that to mean a set of UML diagrams separate from the code. A set of UML diagrams may represent parts of a design, but it is not the design. The Design of a software project is an abstract concept. It has to do with the overall shape and structure of the program as well as teh detailed shape and structure of each module, class, and method. It can be represented by many different media, but its final embodiment is source code. In the end, the source code is the design.

                                                                                                   Uncle Bob: Agile Software Development, Principles, Patterns, and Practices  

 

Lesson 7.    Don’t waste your time.
The agile development manifesto values working software over comprehensive documentation. This guideline has proven valuable. Several projects I have experienced went overboard on plans, requirements specifications, designs, test plans, process documentation, release plans, etc. Don’t get me wrong - there is value in these documentation artifacts. The key is to do “just enough”. Know the audience for your documentation and do the minimum amount to meet their needs. Any more than that is waste. Every activity in the development cycle should add value to the business, product or end user. Spend your time on activities that count.

                                                                                                    James Waletzky: Lessons in Software from James Waletzky

 

UML图, 设计文档只是用来交流的工具，是设计的一部分，而非全部。如果Reviewer指出文档不全，设计缺陷是为了引导作者思考，指出作者的盲点，那我们是应该虚心热诚地接受的。 而如果Reviewer只是假装不懂，死咬着文档不全，不够具体不放，那就是Reviewer的不是了。