后端面试38讲_44_加餐_软件设计文档示例模板

你好，我是李智慧。

上一篇文章中呢，我讲了七种常用的UML模型图的画法，以及这些画法分别适用于什么样的设计阶段。

我们也可以将不同设计阶段输出的模型放在一个文档中。

对每张模型图呢都配以适当的文字说明，构成一篇设计文档。

对于规模不太大的软件系统来说，我们可以将概要设计文档和详细设计文档合并成一个设计文档。

通常文档开头呢使设计概述简单描述业务场景要解决的核心问题领域是什么？虽然业务场景呢应该在专门的需求文档中详细描述，但是在设计文档中必须简单描述一下，以保证设计文档的完整性。

这样的话呢，就算是脱离了需求，文档，阅读者也能够理解主要的设计。

此外，在设计概述中，还需要描述设计的非功能阅约锁，比如关于性能、可用性、维护性、安全性，甚至开发和部署成本方面的设计约束和目标。

然后就是具体的设计了。

通常设计文档的第一张设计模型图呢应该是部署图，通过部署图描述系统，整个物理模型蓝图，也就是未来的系统长什么样。

如果系统中包含几个子系统呢？那么还需要描述子系统间的动态调用关系。

我们可以通过子系统序列图子系统活动图进行描述。

子系统内部的最顶层设计呢就是组件图描述子系统由哪些组件组成。

在不同场景中，组件之间的调用时序图是什么样的？每个组件内部需要用类图进行建模描述，对于不同场景，用时序图描述类之间的动态调用关系。

对于有复杂状态的类，用状态图描述状态转换就好了。

今天的文章呢我会展现一个设计文档。

示例模板，你可以参考这个模板，编写你的设计文档，祝你阅读愉快。