如何利用UML建模来编写软件设计说明？

Posted 2021-04-17 软件工程之思

都说一图胜千言。

使用UML工具进行建模，绘制各种视图，会使得我们的技术文档可读性更好。那它如何与我们实施GJB5000需要编写的软件设计说明结合呢？

下面就是建模和编写软件设计说明结合的建议。

使用UML可以建立静态视图和动态视图。其中静态视图包括用例视图、类图和包图；动态视图包括协作图、交互图、时序图、动态图等等。对于软件设计说明来说，它主要使用类图来描述软件的部件的详细设计，并根据需要采纳某种动态视图作为辅助。

众所周知，我们的软件设计都是在做好需求分析的前提下进行的，要绘制类图之前，也是必须要完成需求分析，并获得用例视图、用例场景和用例规约。

绘制类图，先要将用例转换成分析类（包括实体类、边界类和控制类），再根据需要转换成设计类。

如果系统中的许多功能具备相似的实现模式，则没有必要为每一个用例转换成设计类，一个典型功能的设计类就可以起到指导开发的作用。而对于复杂的、特殊的功能，则应当转换成设计类。

这样，我们在软件设计说明中要描述部件设计和接口设计时，就可以使用类图来描述。

同样的，以供电系统为例，我们从用户申请永久用电的场景中可以得到一个申请登记的用例的分析类图，如下图所示：

然后，我们根据需要将分析类图转换成设计类图，如下图所示：

在实际设计的过程中，还要考虑把分析类、设计类与软件架构结合起来，要确定这些类处于软件架构的哪个层次中。这里不作阐述，有兴趣的请阅读参考书目。

总之，在建立需求分析得出的用例基础之上，使用类图可以将软件设计更清晰地表述出来。

这正是：

基于用例作设计，绘制类图更清晰

建立模型入文档，软件设计更明晰

参考书目：大象：Thinking in UML（第二版），谭云杰，中国水利水电出版社

---

作者简介：王小双，长期从事GJB5000推广、实施、评价、改进的工作，创建《软件工程之思》微信公众号，一直在《软件工程之思》分享GJB5000、CMMI、软件工程的知识和感悟。现致力于GJB5000咨询以及软件过程改进、软件工程能力提升的研究工作。