架构设计文档编写说明

首页:

项目logo

项目名

编写人名称、日期、版本号

简述

第二页:

版本历史记录,一般由编写人姓名、更新日子、版本号、备注组成

1:Summary(概述)

......

1.1 Purpose and goals(目标)

......

1.2 Scope(功能)

......

1.3 Audience(面向人员)

......

1.4 Reference Documents(参考文档)

......

1.5 Acronyms & abbreviations(缩略词)

2:Architecture(组织架构)

2.1 Overview(总览)

......

2.2 User Story(用例)

......

3: Components(组件)

3.1 Component1

......

3.2 Component2

......

4:Features(特性)

4.1 Ex. Cache(比如缓存机制)

......

5:Scenario(场景,用于描述各种可能的工作流)

5.1 Workflow1

......

5.2 Workflow2

......

6:Risks(潜在风险)

......

7:Testability(测试)

......

8:Security(安全性)

......

9:Performance(性能)

......

FYI(以下部分与本主题无关):

==============================================================

性能

防反复提交

数据库缓存

前台验证

后台验证

ajax支持

国际化

事务管理

异常处理

security安全性

可测试性

解耦合,尤其是service与controller,便于以后扩展成restful或者WAP

==============================================================

 

猜你喜欢

转载自crazysky.iteye.com/blog/1545523