`

架构设计文档编写说明

阅读更多

首页:

项目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

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

 

 

分享到:
评论

相关推荐

    安卓app项目架构设计文档

    安卓app项目架构设计文档 1,项目架构,2,技术实现

    软件(架构)设计文档模板.doc

    本详细设计说明书编写的目的是说明程序模块的设计考虑,包括程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员...

    web项目详细设计文档

    让初学web开发人员快速上手项目详细设计文档编写!

    微服务概要设计说明书模板

    文档:概要设计文档,可以帮我们处理程序性能瓶颈,程序移植性短板,也方便后期维护拓展,文档输出也方便后期交付和交接。 项目目录: 1 文档简介 1.1 编写目的 1.2 文档范围 1.3 缩略语 2 项目概述 2.1 建设...

    03架构设计的目的

    以史为鉴,对我们了解架构设计的目的很有帮 助。谈到架构设计,相信每个技术人员都是耳熟能详,但如果深入探讨一下,“为何要做架构设 计?”或者“架构设计目的是什么?”类似的问题,大部分人可能从来没有思考过,...

    软考高级系统架构设计师资料

    “系统架构设计师,属于计算机技术与软件(高级)专业技术资格。...能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。”

    系统架构设计师历年真题.rar

    能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。 架构师是由国外引进的一个概念,国外软件开发的几个职位是技术官、架构师、设计...

    软件架构文档模板

    软件架构设计文档模板,有详细的编写规范及要求,目录层级清晰

    软件架构设计---软件架构文档化

    它包含两个方面:一是过程,编档过程能促使架构设计师进一步思考,使得架构更加完善;二是结果,描述架构的文档将作为架构开发的成果,供项目关系人使用。 1.架构文档的使用者 架构文档的使用者是架构的项目关系人...

    系统架构设计师考试大纲(2009版)

    系统架构设计师考试大纲(2009版) 考试合格人员应能够根据系统需求规格说明书,...能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。

    (cicd架构文档)测试环境说明步骤.doc

    公司现使用环境,如果下载后有问题,可留言,看见留言后会回复协助解决。本文档是自己一边搭建,一边编写,借助其他文档与官网文档为参考。

    2017年系统架构设计师考试大纲

    2017年系统架构设计师考试大纲,考试合格人员应能够根据系统需求规格说明书,结合应用领域和技术发展的实际情况,考虑有关约束条件,设计正确、合理的软件架构,确保系统架构具有良好的特性;能够对项目睥系统架构...

    系统架构设计师考试大纲.docx

    2020年最新考纲 1.考试目标 考试合格人员应能够根据系统需求规格说明书,结合应用...能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。

    云计算系统架构文档 汇总上

    阿里巴巴中文站架构设计实践 何崚 pdf">云计算系统架构文档 上 DevOps 从云端到地面 熊节 pdf DevOps 让持续交付成为可能 乔梁 pdf eBay技术平台:掌控十亿级交易数据 Tony Ng pdf Facebook大数据实时分析案例...

    软件架构文档(样例).pdf

    通过实际软件开发过程中的架构设计实例,为大家在编写架构文档时提供范例!

    系统架构 实际项目系统架构设计

    系统架构 系统机构文档范例 以实际项目为背景,手把手的教你如何编写系统架构文档

    RUP 中文版的架构文档模板

    RUP 中文版的架构文档模板,供编写架构设计的人参考

    系统架构设计师考试大纲-2020.zip

    2020年最新考纲 1.考试目标 考试合格人员应能够根据系统需求规格说明书,结合...能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。

    互联网架构师指导教程, 架构师之路, 系统架构师的视频教学, 包含配套讲义

    系统架构设计师是一个最终确认和评估系统需求,给出开发规范,搭建系统实现的核心...能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。

    系统架构师论文81篇

    能够按照相关标准编写相应的设计文档;能够与系统分析师、项目管理师相互协作、配合工作;具有高级工程师的实际工作能力和业务水平。 架构师是由国外引进的一个概念,国外软件开发的几个职位是技术官、架构师、设计...

Global site tag (gtag.js) - Google Analytics