写好设计文档

写好设计文档

怎样算一个好的设计文档

• 文档意图清晰，描述逻辑有序
• 动静结合，既有静态模型又有动态模型
• 注重分析生产活动的生命周期
• 列出能力矩阵
• 善于发现概念，将捕捉到的概念显示化，建立领域模型
• 划清边界，构建层次
• 有不同的视图，一图胜千言。比如有用例图，领域模型图，活动图，时序图，状态图，业务流程图，业务架构图，应用架构图，技术架构图等等。

静态建模

用例收集

用例是设计文档后续所有环节的输入，非常重要。

“处理配送订单”用例描述

• 用例名称：处理配送订单
• 概述：供应商请求一个配送订单；系统确定库存满足要求，并且显示订单。
• 参与者：供应商
• 前置条件：供应商需要处理一个配送订单并且一个配送订单存在。
• 主序列：
  1. 供应商请求下一个配送订单。
  2. 系统检索并且显示配送订单。
  3. 供应商为配送订单请求请求商品库存检查。
  4. 系统确定系统中的商品对于满足订单是可用的，并且保留这些商品。
  5. 系统给供应商显示库存信息，并且确认商品被保留。
• 可替换序列：步骤4：如果商品库存不存在，系统显示警告信息。
• 后置条件：系统为配送订单保留了库存商品。

分析生产活动的生命周期

任何业务都可以抽象为生产活动的过程，人们通过生产产品，供其他人消费。生产活动按照时间维度可以简化为生产前，生产中，生产后。

能力矩阵图

根据生命周期每个阶段梳理功能矩阵图

领域模型

• 发现概念：通过分析用例提取概念，用实体表示概念。
• 静态实体：作为生产资料，比如商品，店铺和会员
• 过程实体：在生产过程中产生，比如交易中的订单，优惠券核销记录
• 实体关联关系
  • 1：1
  • 1：N
  • N：N
• 类之间关系
  • 组合和聚合
  • 泛化和特化
• 领域能力：能力就是对实体施加的操作或发出的命令
• 划分业务领域：根据能力的主题，实体的密切关系，定义出业务域
• 将业务域组合规划出中心，比如会员中心，订单中心，商品中心

---

订单模型

业务域

功能矩阵表

动态交互建模(后续补充)

• 通信图
• 时序图
• 状态图

来源：CSDN

作者：Ydoing

链接：https://blog.csdn.net/csujiangyu/article/details/103656733