Design document template based on scrum story

xiabin edited this page Jan 17, 2016 · 1 revision

基于Story的设计文档模板

在Scrum实践中的设计文档与传统方式差异较大.因此采取针对 单独的story进行设计. 模板如下

简介

设计文档模板

说明本设计文档是遵循哪个模板编写的

Story 描述

描述本设计针对的story内容. 尽可能避免技术细节.

以及story相关联的使用场景

核心设计

从整体上描述设计内容.内容一般包括,涉及到哪些服务/模块/组件 以及他们的

  • 职责
  • 事件流
  • 异常情况以及对应的事件流

图解

通过UML图表的形式来描述设计思想.与”核心设计”配合阐述设计思想的.

常见的图表类型有

  • 用例图 (use case diagram)
  • 类图 (class diagram)
  • 时序图 (sequence diagram)
  • 状态图 (state diagram)

使用哪种图进行描述,可以通过此设计涉及到的关键视角.比如

  • 主题是数据模型的建立,就采用 class diagram + ER diagram
  • 主题是消息/数据的流通,就采用 sequence diagram
  • 主题是部署,配置之类的就采用 deployment diagram
  • 主题是模块之间的关系,就采用 use case diagram
  • 主题是几种状态间的切换,就采用 sate diagram

若是不太熟悉UML的使用,推荐在这里入门 若是没有合适的UML编写工具,推荐使用 plantuml 若是数据库表结构的描述,允许采用ERD进行.

异常说明

对本方案无法解决的一些特殊情况进行说明

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.