`

架构设计文档编写说明

 
阅读更多

首页:

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

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

 

 

分享到:
评论

相关推荐

    数据仓库架构设计文档v1.2.docx

    数据中台架构文档V1.21目录版本说明是指数据仓库架构设计文档的目录结构和版本说明。该部分内容主要介绍了数据仓库架构设计文档的目录结构、版本记录和变更记录等方面的内容。 编写目的是指数据仓库架构设计文档的...

    架构设计文档

    《网站架构设计文档》 网站架构设计是构建高效、稳定、可扩展的互联网应用的关键步骤。这份文档将深入探讨如何进行有效的网站架构设计,确保系统的性能、可维护性以及技术选型的合理性。 1. **架构设计的目标** -...

    软件架构设计说明书.docx

    《图书杂志采购和借阅系统》的软件架构设计说明书详细阐述了系统的设计和构建过程,旨在为项目相关人员提供全面的理解和指导。以下是该文档的主要内容摘要: 一、简介 这部分明确了文档的编写目的,旨在记录系统...

    XXX软件架构设计文档.pdf

    编写软件架构设计文档需要满足以下要求: 1. 准确性:软件架构设计文档必须准确反映软件的设计思想和架构模式。 2. 完整性:软件架构设计文档必须完整地描述软件的所有方面。 3. 一致性:软件架构设计文档必须与...

    安卓app项目架构设计文档

    ### 安卓APP项目架构设计文档 #### 一、项目架构概述 在安卓APP开发过程中,合理的项目架构设计是确保应用程序高效、可维护的关键因素之一。一个良好的架构不仅能够提高开发效率,还能够帮助团队更好地应对未来的...

    ADMEMS方法推荐《软件架构设计文档》模板

    《软件架构设计文档》模板是基于ADMEMS方法的一个实用工具,它提供了标准化的框架,帮助架构师系统化地编写架构文档。v2.dot版本可能意味着这是一个经过迭代和优化的版本,包含了更多的实践经验和反馈。 使用这个...

    微服务架构设计.doc

    以下是对微服务架构设计的一些关键知识点的详细说明: 1. **业务领域组件**:微服务的核心是围绕业务领域进行服务划分,每个服务代表一个或多个业务功能,这样可以降低服务间的耦合度,便于团队协作和独立部署。 2...

    架构使用说明文档

    【架构使用说明文档】主要介绍了如何搭建和使用一个基于Java技术的开发环境,以及详细的开发步骤,涵盖了服务器配置、客户端要求、开发环境安装、配置以及软件工具的使用。以下是具体的详细说明: 一、运行开发环境...

    微软官方架构设计文档

    ### 微软官方架构设计文档知识点解析 #### 一、文档概述 《微软官方架构设计文档》是一份由微软公司发布的官方技术文档,主要聚焦于应用程序架构设计领域。该文档内容丰富、精炼,并提供了大量的实例来帮助读者...

    需求分析、概要设计、详细设计文档编写资料汇总

    这份"需求分析、概要设计、详细设计文档编写资料汇总"包含了丰富的实例报告,旨在提供从入门到精通的全程指导,帮助你更好地理解和实践这些关键步骤。 **需求分析**是软件开发的第一步,其目的是明确并理解用户或...

    软件系统架构设计说明书模板

    软件系统架构设计说明书是指导软件开发过程中的重要文档,旨在明确系统的整体结构、组件间的相互关系以及设计原则。本文档由科技有限公司XX编写,旨在为项目团队提供清晰的架构蓝图,确保系统的设计符合业务需求和...

    web项目详细设计文档

    通过详细的文档编写,可以有效避免后期开发中的混乱,提高开发效率。 **1.2 背景** - **软件系统的名称**:基于Java和数据库技术构建的电子商城系统。 - **任务提出者**:实训教师吕老师。 - **开发者**:梦之队。...

    设计文档规范设计文档格式模板,包括需求设计、概要设计、需求说明书、详细设计等

    中国国家标准化管理委员会对软件设计文档有相应的国家标准,例如GB/T 8566《信息技术 软件生存周期过程》和GB/T 16680《软件文档编制规范》等,这些标准规定了软件设计文档的内容、格式和编写要求,旨在提高软件质量...

    架构设计说明书,模块设计书,数据库设计书

    在IT行业中,架构设计说明书、模块设计书和数据库设计书是软件开发过程中的核心文档,它们为项目的规划、实施和维护提供了清晰的指导。以下是这些文档的详细解释和相关知识点: 1. 架构设计说明书: 架构设计说明...

    软件架构设计说明书模板

    - **文档编写目的**:这部分主要说明编写此架构设计说明书的原因,可能是为了清晰地传达系统设计思路,确保团队成员对系统结构有统一的理解,或者是为了满足项目管理的需求。 - **文档范围**:明确文档覆盖的范围...

    软件架构设计文档.doc

    软件架构设计文档是软件开发过程中的关键文档之一,主要目的是为软件开发团队提供一个清晰的蓝图,指导整个项目的开发方向和技术选型。这份文档是内部公开的,编号为1002,版本号为V3.0,针对的是名为"测测"的基于...

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

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

Global site tag (gtag.js) - Google Analytics