抱着西瓜吃夏天22
文档的软件设计说明
软件设计阶段结束后要交付软件设计说明书。
它的前半部分在概要设计后完成，后半部分在详细设计后写出。
设计说明书用于双重目的：对于编程和测试，它提供指南；软件交付使用后，为维护人员提供帮助。
软件设计说明书的框架和内容如下：(1)概述。
描述设计工作总的范围，包括系统目标、功能、接口等。
(2)系统结构。
用软件结构图说明本系统的模块划分，扼要说明每个模块的功能，按层次给出各模块之间的控制关系。
(3)数据结构及数据库设计。
对整个系统使用的数据结构及数据库进行设计，包括概念结构设计、逻辑结构设计和物理设计。
用相应的图形和表格把设计结果描述出来。
(4)接口设计。
设计人机界面，说明向用户提供的命令以及系统的返回信息；设计外部接口，说明本系统与外界的所有接口信息，包括软件与硬件之间的接口、本系统与支持软件之间的接口关系。
(5)模块设计。
按模块功能详细描述每个模块的流程及数据结构。
软件需求分析的文档编制
软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解， 使之成为整个开发工作的基础。
编制软件需求说明书的内容要求如下：1 引言1.1编写目的 说明编写这份软件需求说明书的目的，指出预期的读者。
1.2背景 说明：a.待开发的软件系统的名称；b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；C.该软件系统同其他系统或其他机构的基本的相互来往关系。
1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料 列出用得着的参考资料，如：a.本项目的经核准的计划任务书或合同、上级机关的批文；b.属于本项目的其他已发表的文件；c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2 任务概述2.1目标 叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。
解释被开发软件与其他有关软件之间的关系。
如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。
如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。
|2.2用户的特点 列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使用频度。
这些是软件设计工作的重要约束2.3假定和约束 列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。
3 需求规定3.1对功能的规定 用列表的方式（例如IPO表即输入、处理、输出表的形式），逐项定量和定性地叙述对软件所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明软件应支持的终端数和应支持的并行操作的用户数。
3.2对性能的规定3.2.1精度 说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。
3.2.2时间特性要求 说明对于该软件的时间特性要求，如对：a.响应时间；b.更新处理时间；c.数据的转换和传送时间；d.解题时间； 等的要求。
3.2.3灵活性 说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：a.操作方式上的变化；b.运行环境的变化；c.同其他软件的接口的变化；d.精度和有效时限的变化；e.计划的变化或改进。
对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。
3.3输入输出要求 解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。
对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。
3.4数据管理能力要求 说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。
3.5故障处理要求 列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。
3.6其他专门要求 如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。
4 运行环境规定4.1设备 列出运行该软件所需要的硬设备。
说明其中的新型设备及其专门功能，包括：a.处理器型号及内存容量；b.外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量；c.输入及输出设备的型号和数量，联机或脱机；d.数据通信设备的型号和数量；e.功能键及其他专用硬件4.2支持软件 列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。
4.3 接口 说明该软件同其他软件之间的接口、数据通信协议等。
4.4控制 说明控制该软件的运行的方法和控制信号，并说明这些控制信号的来源。
应用软件是怎样设计的？
软件系统的开发是按阶段进行的，一般划分为以下阶段：可行性讨论；需求分析；系统设计（概要设计、详细设计）；程序开发；编码，单元测试；系统测试；系统维护。
软件开发过程中要明确各阶段的工作目标、实现该目标所必需的工作内容以及达到的标准。
只有在上一个阶段的工作完成后，才能开始下一阶段的工作。
1.可行性讨论 明确系统的目的、功能和要求，了解目前所具备的开发环境和条件，论证的内容有：① 在技术能力上是否可以支持；② 在经济上效益如何；③ 在法律上是否符合要求；④ 与部门、企业的经营和发展是否吻合；⑤ 系统投入运行后的维护有无保障。
可行性讨论的目的是判定软件系统的开发有无价值。
分析和讨论的内容形成“系统开发计划书”，主要内容有： （1） 开发的目的及所期待的效果； （2） 系统的基本设想，涉及的业务对象和范围； （3） 开发进度表，开发组织结构； （4） 开发、运行的费用； （5） 预期的系统效益； （6） 开发过程中可能遇到的问题及注意事项。
2、系统需求分析 系统需求分析是软件系统开发中最重要的一个阶段，直接决定着系统的开发质量和成败，必须明确用户的要求和应用现场环境的特点，了解系统应具有哪些功能、数据的流程和数据之间的联系。
需求分析应有用户参加，到使用现场进行调研学习，软件设计人员应虚心向技术人员和使用人员请教，共同讨论解决需求问题的方法，对调查结果进行分析，明确问题的所在。
需求分析的内容编写成“系统需求分析报告”。
3.系统设计 可根据系统的规模分成概要设计和详细设计两个阶段。
概要设计包括：① 划分系统模块；② 每个模块的功能确定；③ 用户使用界面概要设计；④ 输入输出数据的概要设计；⑤ 报表概要设计；⑥ 数据之间的联系、流程分析；⑦ 文件和数据库表的逻辑设计；⑧ 硬件、软件开发平台的确定；⑨ 有规律数据的规范化及数据惟一性要求。
系统的详细设计是对系统的概要设计进一步具体化，其主要工作有：① 文件和数据库的物理设计；② 输入输出记录的方案设计；③ 对各子系统的处理方式和处理内容进行细化设计；④ 编制程序设计任务书。
程序说明书通常包括程序规范、功能说明、程序结构图，通常用HPIPO(Hierarchy Plus Input Process Output)图描述。
4、程序开发 根据程序设计任务书的要求，用计算机算法语言实现解题的步骤，主要工作包括：① 模块的理解和进一步划分；② 以模块为单位的逻辑设计，也就是模块内的流程图的编制；③ 编写代码，用程序设计语言编制程序；④ 进行模块内功能的测试、单元测试。
程序质量的要求包括：① 满足要求的确切功能；② 处理效率高；③ 操作方便，用户界面友好；④ 程序代码的可读性好，函数、变量标识符合规范；⑤ 扩充性、维护性好。
降低程序的复杂性也是十分重要的。
系统的复杂性由模块间的接口数来衡量，一般地讲，n个模块的接口数的最大值为n(n-1)/2；若是层次结构，n个模块的接口数的最小值为n-1。
为使复杂性最小，对模块的划分设计常常采用层次结构。
要注意编制的程序或模块应容易理解、容易修改，模块应相互独立，对某一模块的修改应对其他模块的功能不产生影响，模块间的联系尽可能少。
5.系统测试 测试是为了发现程序中的错误，对于设计的软件，出现错误是难免的。
系统测试通常由经验丰富的设计人员设计测试方案和测试样品，并写出测试过程的详细报告。
系统测试是在单元测试的基础上进行的，包括：① 测试方案的设计；② 进行测试；③ 写出测试报告；④ 用户对测试结果进行评价。
6、文档资料 文档包括开发过程中的所有技术资料以及用户所需的文档，软件系统的文档一般可分为系统文档和用户文档两类。
用户文档主要描述系统功能和使用方法，并不考虑这些功能是怎样实现的；系统文档描述系统设计、实现和测试等方面的内容。
文档是影响软件可维护性、可用性的决定因素，有句话讲，系统编程人员的每一张纸片都要保留，所以文档的编制是软件开发过程中的一项重要工作。
系统文档包括：开发软件系统在计划、需求分析、设计、编制、调试、运行等阶段的有关文档。
在对软件系统进行修改时，系统文档应同步更新，并注明修改者和修改日期，如有必要应注明修改原因，应切记过时的文档是无用的文档。
用户文档包括：① 系统功能描述；② 安装文档，说明系统安装步骤以及系统的硬件配置方法；③ 用户使用手册，说明使用软件系统方法和要求，疑难问题解答；④ 参考手册，描述可以使用的所有系统设施，解释系统出错信息的含义及解决途径。
7、系统的运行与维护 系统只有投入运行后，才能进一步对系统检验，发现潜在的问题，为了适应环境的变化和用户要求的改变，可能会对系统的功能、使用界面进行修改。
要对每次发现的问题和修改内容建立系统维护文档，并使系统文档资料同步更新。
软件著作权申请中的文档（设计说明书或用户手册）怎么写？
中国版权保护中心接收登记的文档包含两种：操作说明书或设计说明书。
设计说明书适合没有界面的嵌入式软件，插件软件，后台运行软件以及游戏软件。
一般包含结构图，软件流程图，函数说明，模块说明，数据接口，出错设计等。
操作说明书适合管理类软件，有操作界面，一般应包含登录界面，主界面，功能界面截图，截图之间有相应的文字说明，能全面展示软件的主要功能。
格式要求：一、说明书应提交前、后各连续30页，不足60页的，应当全部提交。
二、说明书页眉应标注软件的名称和版本号，应当与申请表中名称完全一致，页眉右上应标注页码，说明书每页不少于30行，有图除外，另外截图应该清晰完整。
(1)引言①编写目的：阐明编写手册的目的，指明读者对象。
②项目背景：说明项目的来源、委托单位、开发单位及主管部门。
③定义：列出手册中用到的专门术语定义和缩写词的原意。
④参考资料：列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。
包括项目的计划任务书，合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划；手册中引用的其他资料、采用的软件工程标准或软件工程规范。
(2)软件概述①目标。
②功能。
③性能。
包括数据精确度（包括输入、输出及处理数据的精度），时间特性（如响应时间、处理时间、数据传输时问等），灵活性（在操作方式、运行环境需做某些变更时软件的适应能力）。
(3)运行环境①硬件：列出软件系统运行时所需的硬件最小配置，如计算机型号、主存容量；外存储器、媒体、记录格式、设备型号及数量；输入、输出设备；数据传输设备及数据转换设备的型号及数量。
②支持软件：操作系统名称及版本号；语言编译系统的名称及版本号；数据库管理系统的名称及版本号；其他必要的支持软件。
(4)使用说明①安装和初始化：给出程序的存储形式、操作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件开发工具等。
②输入：给出输入数据或参数的要求。
③输出：给出每项输出数据的说明。
④出错和恢复：出错信息及其含义、用户应采取的措施，如修改、恢复、再启动等。
⑤求助查询：说明如何操作。
(5)运行说明①运行表：列出每种可能的运行情况，说明其运行目的。
②运行步骤：按顺序说明每种运行的步骤，应包括运行控制；操作信息（运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项）；输入/输出文件（给出建立和更新文件的有关信息。
如文件的名称及编号、记录媒体、存留的目录、文件的支配[说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等]）；启动或恢复过程。
(6)非常规过程：提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。
(7)操作命令一览表：按字母顺序逐个列出全部操作命令的格式、功能及参数说明。
(8)程序文件（或命令文件）和数据文件一览表：按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。
(9)用户操作举例。
求【计算机组成与设计 硬件/软件接口】pdf
用户需求说明书模板 文档标识：当前版本：1.0当前状态：草稿发布日期：2015-5-20发布：修改历史日期版本 作者修改内容评审号变更控制号目录1引言... 31.1 编写目的... 31.2 项目背景... 31.3 术语定义... 31.4 参考资料... 32 综合描述... 32.1产品介绍... 32.2 目标范围... 32.3 用户特性...42.4 约定假设... 43 用户需求（可剪裁）... 43.1 总体需求（可剪裁）... 43.2 内容需求（可剪裁）...54 功能需求... 54.1 数据需求（可剪裁）...54.2 接口需求（可剪裁）... 64.3 权限控制需求（可剪裁）... 64.3.1 系统安全要求（软硬件）... 64.3.2 用户角色... 64.3.3 角色权限控制... 65 非功能需求... 65.1 用户界面需求（可剪裁）... 65.2 性能需求（可剪裁）... 75.3 压力需求（可剪裁）... 75.4 主流技术应...参考链接 http://wenku.baidu.com/link?url=sWqyWqKYVsb_h5AwACh8Lr0U39s6_7EV63vsvlWpai_0t-uZoXwqlidc72WMN5K7hz8HcJ_RNqUMIVXkxQMsj-IWjUwMdOO-g2qGqa_kERC
软件项目分析需求
需求分析，我刚做了个项目就用它，不知道是不是你想要的1引言 21.1编写目的 21.2背景 21.3定义 21.4参考资料 22任务概述 22.1目标 22.2用户的特点 32.3假定和约束 33需求规定 33.1对功能的规定 33.2对性能的规定 33.2.1精度 33.2.2时间特性要求 33.2.3灵活性 43.3输人输出要求 43.4数据管理能力要求 43.5故障处理要求 43.6其他专门要求 54运行环境规定 54.1设备 54.2支持软件 54.3接口 54.4控制 5软件需求说明书的编写提示1引言1.1编写目的 说明编写这份软件需求说明书的目的，指出预期的读者。
1.2背景说明：待开发的软件系统的名称；本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；该软件系统同其他系统或其他机构的基本的相互来往关系。
1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料 列出用得着的参考资料，如：本项目的经核准的计划任务书或合同、上级机关的批文；属于本项目的其他已发表的文件；本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2任务概述2.1目标 叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。
解释被开发软件与其他有关软件之间的关系。
如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。
如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。
|2.2用户的特点 列出本软件的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长，以及本软件的预期使甩频度。
这些是软件设计工作的重要约束2.3假定和约束 列出进行本软件开发工作的假定和约束，例如经费限制、开发期限等。
3需求规定 3.1对功能的规定 用列表的方式（例如IPO表即输入、处理、输出表的形式），逐项定量和定性地叙述对软件所提出的功能要求，说明输入什么量、经怎样的处理、得到什么输出，说明软件应支持的终端数和应支持的并行操作的用户数。
3.2对性能的规定3.2.1精度 说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。
3.2.2时间特性要求 说明对于该软件的时间特性要求，如对：响应时间；更新处理时间；数据的转换和传送时间；解题时间；等的要求。
3.2.3灵活性 说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：操作方式上的变化；运行环境的变化；同其他软件的接口的变化；精度和有效时限的变化；计划的变化或改进。
对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。
3.3输人输出要求 解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。
对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。
3.4数据管理能力要求 说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。
3.5故障处理要求 列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。
3.6其他专门要求 如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。
4运行环境规定4.1设备 列出运行该软件所需要的硬设备。
说明其中的新型设备及其专门功能，包括：处理器型号及内存容量；外存容量、联机或脱机、媒体及其存储格式，设备的型号及数量；输入及输出设备的型号和数量，联机或脱机；数据通信设备的型号和数量；功能键及其他专用硬件4.2支持软件 列出支持软件，包括要用到的操作系统、编译（或汇编）程序、测试支持软件等。
4.3接口 说明该软件同其他软件之间的接口、数据通信协议等。
4.4控制 说明控制该软件的运行的方法和控制信号，并说明这些控制信号的来源。
结构化设计和结构化分析的关系
简单来说，结构化分析是结构化设计的基础。
结构化分析：structured analysis。
使用数据流程图、数据字典、结构化语言、判定表和判定树等工具，来建立一种新的、称为结构化说明书的目标文档-需求规格说明书。
结构化体现在将软件系统抽象为一系列的逻辑加工单元，各单元之间以数据流发生关联。
结构化分析是70年代末，由Demarco等人提出的，旨在减少分析活动中的错误，建立满足用户需求的系统逻辑模型。
该方法的要点是：面对数据流的分解和抽象；把复杂问题自顶向下逐层分解，经过一系列分解和抽象，到最底层的就都是很容易描述并实现的问题了。
一、软件设计过程对程序结构、数据结构、过程细节和接口细节逐步细化、评审和编写文档的过程。
从技术角度上，软件设计分成体系结构设计、数据设计、过程设计、接口设计4个方面的工作。
从管理角度上讲，软件设计分为概要设计和详细设计两个阶段。
二、软件设计目标设计必须实现分析模型中描述的所有显示需求，必须满足用户希望的所有隐式需求；设计必须是可读、可理解的，使得将来易于编程、易于测试、易于维护；设计应从实现角度出发，给出数据、功能、行为相关的软件全貌。
三、基本原理和相关概念⑴抽象化：常用的抽象化手段有过程抽象、数据抽象和控制抽象 ● 过程抽象：任何一个完成明确动能的操作都可被使用者当做单位的实体看待，尽管这个操作时机上可能由一系列更低级的操作来完成。
● 数据抽象：与过程抽象一样，允许设计人员在不同层次上描述数据对象的细节。
● 与过程抽象和数据抽象一样，控制抽象可以包含一个程序控制机制而无须规定其内部细节。
⑵自顶向下，逐步细化：将软件的体系结构按自顶向下方式，对各个层次的过程细节和数据细节逐层细化，知道用程序设计语言的语句能够实现为止，从而最后确立整个的体系结构。
⑶模块化：将一个待开发的软件分解成若干个小的简单的部分——模块，每个模块可独立地开发、测试，最后组装成完整的程序。
这是一种复杂问题的“分而治之”的原则。
模块化的目的是使程序结构清晰，容易阅读，容易理解，容易测试，容易修改。
⑷控制层次：表明了程序构件（模块）的组织情况。
控制层次往往用程序的层次结构（树形或网型）来表示。
● 深度：程序结构的层次数，可以反映程序机构的规模和复杂程度。
● 宽度：同一层模块的最大模块个数 ● 模块的扇出：一个模块调用（或控制）的其他模块数 ● 模块的扇入：调用（或控制）一个给定模块的模块个数 ⑸信息屏蔽：将每个程序的成分隐蔽或封装在一个单一的设计模块中，定义每一个模块时尽可能少的显露其内部的处理，可以提高软件的可修改性，可测试性和可移植性。
⑹模块独立：每个模块完成一个相对特定独立的子功能，并且与其他模块之间的联系简单。
衡量度量标准有两个：模块间的耦合和模块的内聚。
模块独立性强必须做到高内聚低耦合。
● 耦合：模块之间联系的紧密程度，耦合度越高模块的独立性越差。
耦合度从低到高的次序为：非直接耦合、数据耦合、标记耦合、控制耦合、外部耦合、公共耦合、内容耦合。
● 内聚是指内部各元素之间联系的紧密程度，内聚度越低模块的独立性越差。
内聚度从低到高依次是：偶然内聚、逻辑内聚、瞬时内聚、过程内聚、通信内聚、顺序内聚、功能内聚。
转载请注明出处51数据库 » 软件通讯接口设计文档
