软件详细设计文档模板(最全面)
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
6.4.2
设计系统内部各功能模块间的调用关系和数据接口。
6.4.3
规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打印输出等设计。此部分内容可能比较多。
7.
7.1
7.2
- DevelopmentHale Waihona Puke Baiduevnironment: programming lanuague, database
4.1.3
4.1.4
4.1.5
4.2
4.2.1
应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。
4.2.2
系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，全局数据格式，系统性能要求等。
5.
划分系统功能模块或子系统（如果有或者有必要，特别是大型的软件系统）。
6.3
按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。此为详细设计的主要部分之一。
用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能。以上建议采用HIPO图进行功能分解与模块描述，更高的要求建议采用IDEF0方法进行功能模型设计。
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
5.1
包括数据文件名称及其所在目录，功能说明，具体常量说明等。
5.2
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
5.3
包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。
6.
6.1
6.2
对系统的组成及逻辑结构进行设计前确认。
对详细设计更高的要求建议用IDEF0图进行各功能模块的设计。
如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造等），则相应的设计工作应该设立子课题完成。
6.4
系统界面说明应用系统软件的各种接口。整个系统的其他接口（如系统硬件接口、通讯接口等）在相应的部分说明。
6.4.1
根据系统界面划分进行系统外部界面设计，对系统的所有外部接口（包括功能和数据接口）进行设计。
8.
8.1
8.2
8.2.1
模块1主要分为以下几个子模块：子模块1、子模块2和子模块N。
8.2.1.1
8.2.1.1.1
8.2.1.1.2
简要描述子模块1的业务功能。
8.2.1.1.3
详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规则。
详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。
Vs 2010 - svn - iss 6.1 + - mysql/sql server 2005/2008 - .net framwork 4.0
- Testing & production environment: OS, database - .net framwork 4.0
Windwos 2003, iis 6.0, MySQL,
3.1
3.1.1
3.1.2
3.1.3
3.1.4
3.1.5
4.
着重解决系统总体结构确认及界面划分问题。
4.1
对系统组成、逻辑结构及层次进行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括：
4.1.1
4.1.2
本项目需求规格说明书用于从总体上指导课程管理系统项目各个功能模块开发顺利进行并最终得到通过评审的项目产品。本项目需求规格说明书面向项目组全体成员。
1.3
定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。
序号
术语或缩略语
说明性定义
1
PM
Project Manager,项目经理
2
1.4
研发生产中心
文档编号
版本
A1
密级
商密A
项目名称
Xx系统
项目来源
Xxx系统
详细设计说明书
(内部资料请勿外传)
编写：
刘玉龙
日期：
2018-2-10
检查：
日期：
审核：
日期：
批准：
日期：
XX公司
版权所有不得复制
文档变更记录
序号
变更（+/-）说明
作者
版本号
日期
批准
1
2
1.
1.1
在日常教学活动中，为了检验教学质量，考察学生对于理论与实践的掌握情况以及教学质。根据学生所学学科生成考核试题检测其学习效果和教师的教学质量进行量化考核而提出的综合性的、全学科的、覆盖大多数学科基础教学内容的课程管理系统。项目背景规划如表1.1所示。
详细设计应用系统的各个构成模块完成的功能及其相互之间的关系，用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系，以及需求、功能和模块三者之间的交叉参照关系。
每个模块的描述说明可参照以下格式：
模块编号：
模块名称：
输入：
处理：
算法描述：
输出：
其中处理和算法描述部分主要采用伪码或具体的程序语言完成。
项目名称
项目委托单位
任务提出者
项目承担单位
课程管理系统
黄振华
黄振华
闫亮、刘玉龙、凌文
表1.1 项目背景规划
课程管理系统是教学过程阶段性测评的一个重要组成部分，它需要学生信息系统提供学生的基本资料，包括姓名，学号，专业，班级等基础信息；另外，它还需要题库系统提供考核试题。
1.2
为了保证项目团队按时保质地完成项目目标，便于项目团队成员更好地了解项目情况，明确项目需求，使项目工作开展的各个过程合理有序，有必要以文件化的形式，把对于在需求分析的内容以书面的方式描述出来，作为项目团队成员以及项目干系人之间的共识与约定，项目生命周期内的所有项目活动的行动基础，项目团队开展和检查项目工作的依据。
文档格式要求按照我国GB/T8567-1988国家标准和IEEE/ANSI830-1993标准规范要求进行。包括以下文件：
课程管理系统需求说明书
软件工程项目开发文档范例
软件工程国家标准文档
软件需求说明书编写规范
书籍包括：
《软件项目管理》 朱少民，韩莹 编著人民邮电出版社
《软件项目管理》 Rajeev T Shandilya 编著 科学出版社
1.5
文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ]
绘图工具：[使用的UML工具，如Rose、Jude、Visio]
2.
2.1
2.1.1
2.1.2
2.1.3
2.1.4
3.
主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。
设计系统内部各功能模块间的调用关系和数据接口。
6.4.3
规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打印输出等设计。此部分内容可能比较多。
7.
7.1
7.2
- DevelopmentHale Waihona Puke Baiduevnironment: programming lanuague, database
4.1.3
4.1.4
4.1.5
4.2
4.2.1
应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。
4.2.2
系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，全局数据格式，系统性能要求等。
5.
划分系统功能模块或子系统（如果有或者有必要，特别是大型的软件系统）。
6.3
按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。此为详细设计的主要部分之一。
用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能。以上建议采用HIPO图进行功能分解与模块描述，更高的要求建议采用IDEF0方法进行功能模型设计。
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
5.1
包括数据文件名称及其所在目录，功能说明，具体常量说明等。
5.2
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
5.3
包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。
6.
6.1
6.2
对系统的组成及逻辑结构进行设计前确认。
对详细设计更高的要求建议用IDEF0图进行各功能模块的设计。
如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造等），则相应的设计工作应该设立子课题完成。
6.4
系统界面说明应用系统软件的各种接口。整个系统的其他接口（如系统硬件接口、通讯接口等）在相应的部分说明。
6.4.1
根据系统界面划分进行系统外部界面设计，对系统的所有外部接口（包括功能和数据接口）进行设计。
8.
8.1
8.2
8.2.1
模块1主要分为以下几个子模块：子模块1、子模块2和子模块N。
8.2.1.1
8.2.1.1.1
8.2.1.1.2
简要描述子模块1的业务功能。
8.2.1.1.3
详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规则。
详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。
Vs 2010 - svn - iss 6.1 + - mysql/sql server 2005/2008 - .net framwork 4.0
- Testing & production environment: OS, database - .net framwork 4.0
Windwos 2003, iis 6.0, MySQL,
3.1
3.1.1
3.1.2
3.1.3
3.1.4
3.1.5
4.
着重解决系统总体结构确认及界面划分问题。
4.1
对系统组成、逻辑结构及层次进行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括：
4.1.1
4.1.2
本项目需求规格说明书用于从总体上指导课程管理系统项目各个功能模块开发顺利进行并最终得到通过评审的项目产品。本项目需求规格说明书面向项目组全体成员。
1.3
定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。
序号
术语或缩略语
说明性定义
1
PM
Project Manager,项目经理
2
1.4
研发生产中心
文档编号
版本
A1
密级
商密A
项目名称
Xx系统
项目来源
Xxx系统
详细设计说明书
(内部资料请勿外传)
编写：
刘玉龙
日期：
2018-2-10
检查：
日期：
审核：
日期：
批准：
日期：
XX公司
版权所有不得复制
文档变更记录
序号
变更（+/-）说明
作者
版本号
日期
批准
1
2
1.
1.1
在日常教学活动中，为了检验教学质量，考察学生对于理论与实践的掌握情况以及教学质。根据学生所学学科生成考核试题检测其学习效果和教师的教学质量进行量化考核而提出的综合性的、全学科的、覆盖大多数学科基础教学内容的课程管理系统。项目背景规划如表1.1所示。
详细设计应用系统的各个构成模块完成的功能及其相互之间的关系，用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系，以及需求、功能和模块三者之间的交叉参照关系。
每个模块的描述说明可参照以下格式：
模块编号：
模块名称：
输入：
处理：
算法描述：
输出：
其中处理和算法描述部分主要采用伪码或具体的程序语言完成。
项目名称
项目委托单位
任务提出者
项目承担单位
课程管理系统
黄振华
黄振华
闫亮、刘玉龙、凌文
表1.1 项目背景规划
课程管理系统是教学过程阶段性测评的一个重要组成部分，它需要学生信息系统提供学生的基本资料，包括姓名，学号，专业，班级等基础信息；另外，它还需要题库系统提供考核试题。
1.2
为了保证项目团队按时保质地完成项目目标，便于项目团队成员更好地了解项目情况，明确项目需求，使项目工作开展的各个过程合理有序，有必要以文件化的形式，把对于在需求分析的内容以书面的方式描述出来，作为项目团队成员以及项目干系人之间的共识与约定，项目生命周期内的所有项目活动的行动基础，项目团队开展和检查项目工作的依据。
文档格式要求按照我国GB/T8567-1988国家标准和IEEE/ANSI830-1993标准规范要求进行。包括以下文件：
课程管理系统需求说明书
软件工程项目开发文档范例
软件工程国家标准文档
软件需求说明书编写规范
书籍包括：
《软件项目管理》 朱少民，韩莹 编著人民邮电出版社
《软件项目管理》 Rajeev T Shandilya 编著 科学出版社
1.5
文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ]
绘图工具：[使用的UML工具，如Rose、Jude、Visio]
2.
2.1
2.1.1
2.1.2
2.1.3
2.1.4
3.
主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。