文档模板2：软件详细设计说明书.docx

《文档模板2：软件详细设计说明书.docx》由会员分享，可在线阅读，更多相关《文档模板2：软件详细设计说明书.docx（16页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、文档模板2：软件详细设计说明书 文档模板2：软件详细设计说明书 文档编号版本 A1 密级商密A 研发生产中心项目名称 XX系统 项目来源 QR-RD-022(Ver1.2) Xxx系统 详细设计说明书 编写: 日期: 检查: 日期: 审核: 日期: 批准: 日期: 版权所有不得复制 supervision upon the acceptance of electric hoist can be installed before installation check before leaving the factory the factory information, including fac

2、tory certificate, inspection reports and so on whether met with factory-installed condition. Its installation, only to release the running gear, running gear wheel can be fixed on the track under the steel flange, and power lines running. 1) before the installation, must be fully informed of the man

3、ufacturer for the installation of electric hoists on technical performance, usage, installation instructions. 2) after the transfer of equipment, electric hoist track embedded parts design or installation, the hoist should be first buried track and all its components, structural Assembly, or mechani

4、cal Assembly such as checking . Check the cleaning machine parts are manufactured in the factory are complete, each component has any damage in transport, during storage . Check all parts installed at the Assembly tag belongs to the cleaning machine parts. Anyone who does not belong to the cleaning

5、machine parts or assemblies, not the Assembly together . Found in the Assembly to check damage, defects or missing parts, repair should be carried out, padded 文档变更记录 序号作者版本号日期批准变更(+/-)说明 1 2 supervision upon the acceptance of electric hoist can be installed before installation check before leaving t

6、he factory the factory information, including factory certificate, inspection reports and so on whether met with factory-installed condition. Its installation, only to release the running gear, running gear wheel can be fixed on the track under the steel flange, and power lines running. 1) before th

7、e installation, must be fully informed of the manufacturer for the installation of electric hoists on technical performance, usage, installation instructions. 2) after the transfer of equipment, electric hoist track embedded parts design or installation, the hoist should be first buried track and al

8、l its components, structural Assembly, or mechanical Assembly such as checking . Check the cleaning machine parts are manufactured in the factory are complete, each component has any damage in transport, during storage . Check all parts installed at the Assembly tag belongs to the cleaning machine p

9、arts. Anyone who does not belong to the cleaning machine parts or assemblies, not the Assembly together . Found in the Assembly to check damage, defects or missing parts, repair should be carried out, padded 目录 1. 引 言 . . (4) 1.1 编写目的和范 围 . . (4) 1.2 术语 表 . . (4) 1.3 参考资 料 . (4) 1.4 使用的文字处理和绘图工 具 .

10、.4 2. 全局数据结构说 明 . . (4) 2.1 常 量 . . (5) 2.2 变 量 . . (5) 2.3 数据结 构 . .5 3. 模块设 计 . (5) 3.1 用例 图 . . (5) 3.2 功能设计说 明 . . (5) 3.2.1 模块 1 . (5) 3.2.2 模块 2 . .6 4. 接口设 计 . (7) 4.1 内部接 口 . (7) 4.2 外部接 口 . (7) 4.2.1 接口说 明 . (7) 4.2.2 调用方 式 . .7 5. 数据库设计. .7 6. 系统安全保密设计 . . (8) 6.1 说 明 . . (8) 6.2 设 计 . . (

11、8) 6.2.1 数据传输部 分 . . (8) 6.2.2 IP过滤分 部 . (8) 6.2.3 身份验证部 分 . .8 7. 系统性能设 计 . .8 8. 系统出错处 理 . . (8) supervision upon the acceptance of electric hoist can be installed before installation check before leaving the factory the factory information, including factory certificate, inspection reports and so

12、 on whether met with factory-installed condition. Its installation, only to release the running gear, running gear wheel can be fixed on the track under the steel flange, and power lines running. 1) before the installation, must be fully informed of the manufacturer for the installation of electric

13、hoists on technical performance, usage, installation instructions. 2) after the transfer of equipment, electric hoist track embedded parts design or installation, the hoist should be first buried track and all its components, structural Assembly, or mechanical Assembly such as checking . Check the c

14、leaning machine parts are manufactured in the factory are complete, each component has any damage in transport, during storage . Check all parts installed at the Assembly tag belongs to the cleaning machine parts. Anyone who does not belong to the cleaning machine parts or assemblies, not the Assemb

15、ly together . Found in the Assembly to check damage, defects or missing parts, repair should be carried out, padded 1. 引言 1.1 编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、 软件开发人员、软件测试人员和项目评审人员。 1.2 术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。序号术

16、语或缩略语说明性定义 1 2 1.3 参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括: a(需求说明书、架构设计说明书等; b(本项目的其他已发表的文件; c(引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.4 使用的文字处理和绘图工具 文字处理软件:编写设计文档使用的文字处理软件，如MS Office 绘图工具:使用的UML工具，如Rose、Jude、Visio 2. 全局数据结构说明 本章说明本程序系统中使用的全局数据常量、变量和数据结构。 supervision upon the acceptance of electric hoist

17、can be installed before installation check before leaving the factory the factory information, including factory certificate, inspection reports and so on whether met with factory-installed condition. Its installation, only to release the running gear, running gear wheel can be fixed on the track un

18、der the steel flange, and power lines running. 1) before the installation, must be fully informed of the manufacturer for the installation of electric hoists on technical performance, usage, installation instructions. 2) after the transfer of equipment, electric hoist track embedded parts design or

19、installation, the hoist should be first buried track and all its components, structural Assembly, or mechanical Assembly such as checking . Check the cleaning machine parts are manufactured in the factory are complete, each component has any damage in transport, during storage . Check all parts inst

20、alled at the Assembly tag belongs to the cleaning machine parts. Anyone who does not belong to the cleaning machine parts or assemblies, not the Assembly together . Found in the Assembly to check damage, defects or missing parts, repair should be carried out, padded 2.1 常量 包括数据文件名称及其所在目录，功能说明，具体常量说明

21、等。 2.2 变量 本章说明本程序系统中使用的全局数据常量、变量和数据结构。 2.3 数据结 构 包括数据结构名称，功能说明，具体数据结构说明(定义、注释、取值)等。 3. 模块设计 3.1 用例图 3.2 功能设计说明 3.2.1 模块1 模块1主要分为以下几个子模块:子模块1、子模块2和子模块N。 3.2.1.1 子模块1 3.2.1.1.1 设计图 3.2.1.1.2 功能描述 简要描述子模块1的业务功能。 3.2.1.1.3 输入数据 详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规 则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。 3.2.1.1

22、.4 输出数据 详细描述子功能1所产生的数据以及这些数据的表现形式。 3.2.1.1.5 业务 算法和流程 从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。supervision upon the acceptance of electric hoist can be installed before installation check before leaving the factory the factory information, including factory certificate, inspection reports and so on whether met

23、 with factory-installed condition. Its installation, only to release the running gear, running gear wheel can be fixed on the track under the steel flange, and power lines running. 1) before the installation, must be fully informed of the manufacturer for the installation of electric hoists on techn

24、ical performance, usage, installation instructions. 2) after the transfer of equipment, electric hoist track embedded parts design or installation, the hoist should be first buried track and all its components, structural Assembly, or mechanical Assembly such as checking . Check the cleaning machine

25、 parts are manufactured in the factory are complete, each component has any damage in transport, during storage . Check all parts installed at the Assembly tag belongs to the cleaning machine parts. Anyone who does not belong to the cleaning machine parts or assemblies, not the Assembly together . F

26、ound in the Assembly to check damage, defects or missing parts, repair should be carried out, padded 3.2.1.1.6 数据设计 给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明(定义、注释设计、取值)等。相关数据库表，数据存储设计(具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。) 3.2.1.1.7 源程序文件说明 给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能说明，包含的前导文件及函数名称等。 3.2.1.1.8 函

27、数说明 具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局变量，局部变量，返回值，算法说明，使用约束等。 3.2.1.1.9 限制条件 3.2.1.1.10 其他说明 3.2.2 模块2 模块1主要分为以下几个子模块:子模块1、子模块2和子模块N。 3.2.2.1 子模块1 3.2.2.1.1 设计图 3.2.2.1.2 功能描述 简要描述子模块1的业务功能。 3.2.2.1.3 输入数据 详细描述用户输入的数据(包括任何输入设备)以及这些数据的有效性检验规则。 详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。 3.2.2.1.4 输出数据 详细描述子功能

28、1所产生的数据以及这些数据的表现形式。 3.2.2.1.5 业务算法和流程 从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。 3.2.2.1.6 数据设计 给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明(定义、注释设计、取值)等。相关数据库表，数据存储设计(具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。) supervision upon the acceptance of electric hoist can be installed before installation check before leaving the factory the factory