软件项目开发全套文档

《软件项目开发全套文档》由会员分享，可在线阅读，更多相关《软件项目开发全套文档（26页珍藏版）》请在装配图网上搜索。

1、软件项目开发全套文档1操作手册2开发进度月报3可行性研究报告4数据库设计说明书1引言21.1编写目的21.2前景21.3定义21.4参考资料22软件征述22.1软件的结构22.2程序表22.3文卷表33安装与初始化34运行说明34.1运行表34.2运行步骤34.3运行1（标识符）说明3运行控制3操作信息3输入一输出文卷4输出文段4输出文段的复制4恢复过程44.4运行2（标识符）说明45非常规过程56远程操作5操作手册（GB856788）1引言1.1编写目的说明编写这份操作手册的目的，指出预期的读者。1.2前景说明：a 这份操作手册所描述的软件系统的名称；b 该软件项目的任务提出者、开发者、用户

2、（或首批用户）及安装该软件的计算中心。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有用的参考资料，如：a 本项目的经核准的计划任务书或合同、上级机关的批文；b 属于本项目的其他已发表的文件；c 本文件中各处引用的文件、资料，包括所列出的这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2软件征述2.1软件的结构结合软件系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。2.2程序表列出本系统内每个程序的标识符、编号和助记名。2.3文卷表列出将由本系统引用、建立或更新的每个永久性文卷，说明它们各自的标识符、编号、

3、助记名、存储媒体和存储要求。3安装与初始化一步一步地说明为使用本软件而需要进行的安装与初始化过程，包括程序的存载形式，安装与初始化过程中的全部操作命令，系统对这些命令的反应与答复，表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。4运行说明所谓一个运行是指提供一个启动控制信息后，直到计算机系统等待另一个启动控制信息时为止的计算机系统执行的全部过程。4.1运行表列出每种可能的运行，摘要说明每个运行的目的，指出每个运行各自所执行的程序。4.2运行步骤说明从一个运行转向另一个运行以完成整个系统运行的步骤。4.3运行1（标识符）说明把运行1的有关信息，以对操作人员为最方便

4、最有用的形式加以说明。运行控制列出为本运行所需要”的运行流向控制的说明。操作信息给出为操作中心的操作人员和管理人员所需要的信息，如：a. 运行目的；b. 操作要求；c. 启动方法 如应请启动（由所遇到的请求信息启动）、预定时间启动、，等；d. 预计的运行时间和解题时间；e. 操作命令；f. 与运行有联系的其他事项。输入一输出文卷提供被本运行建立、更新或访问的数据文卷的有关信息，如：a. 文卷的标识符或标号；b. 记录媒体；c. 存留的目录表；d. 文卷的支配如确定保留或废弃的准则、是否要分配给其他接受者、占用硬设备的优先级以及保密控制等有关规定。输出文段提供本软件输出的每一一个用于提示、说明、

5、或应答的文段（包括“菜单”）的有关信息，如：a. 文段的标识符；b. 输出媒体（屏幕显示、打印、）；c. 文字容量；d. 分发对象；e. 保密要求。输出文段的复制对由计算机产生，而后需用其他方法复制的那些文段提供有关信息，如：a. 文段的标识符；b. 复制的技术手段；c. 纸张或其他媒体的规格；d. 装订要求；e. 分发对象；f. 复制份数。恢复过程说明本运行故障后的恢复过程。4.4运行2（标识符）说明用与本手册4.3条相类似的方式介绍另一个运行的有关信息。5非常规过程提供有关应急操作或非常规操作的必要信息，如出错处理操作、向后备系统的切换操作以及其他必须向程序维护人员交待的事项和步骤。6远程

6、操作如果本软件能够通过远程终端控制运行，则在本章说明通过远程终端运行本软件的操作过程。开发进度月报（GB856788）l标题开发中的软件系统的名称和标识符分项目名称和标识符分项目负责人签名本期月报编写人签名本期月报的编号及所报告的年月2工程进度与状态2.1进度列出本月内进行的各项主要活动，并且说明本月内遇到的重要事件，这里所说的重要事件是指一个开发阶段（即软件生存周期内各个阶段中的某一个，例如需求分析阶段）的开始或结束，要说明阶段名称及开始（或结束）的日期。2.2状态说明本月的实际工作进度与计划相比，是提前了、按期完成了、或是推迟了？如果与计划不一致，说 明原因及准备采取的措施。3资额耗用与状

7、态3.1资额耗用主要说明本月份内耗用的工时与机时。工时分为三类：a 管理用工时包括在项目管理（制订计划、布置工作、收集数据、检查汇报工作等）方面耗用的工时；b 服务工时包括为支持项目开发所必须的服务工作及非直接的开发工作所耗用的工时；c 开发用工时要分各个开发阶段填写。机时说明本月内耗用的机时，以小时为单位，说明计算机系统的型号。3.2状态说明本月内实际耗用的资源与计划相比，是超出了、相一致、还是不到计划数？如果与计划不一致，说明原因及准备采取的措施。4经费支出与状态4.1经费支出支持性费用列出本月内支出的支持性费用，一般可按如下七类列出，并给出本月支持费用的总和：a. 房租或房屋折旧费；b.

8、 社工资、奖金、补贴；c. 培训费包括给教师的酬金及教室租金；d. 资料费包括复印及购买参考资料的费用；e. 会议费召集有关业务会议的费用；f. 旅差费；g. 其他费用。设备购置费列出本月内支出的设备购置费，一般可分如下三类：a 购买软件的名称与金额；b 购买硬设备的名称、型号、数量及金额；c 已有硬设备的折旧费。4.2状态说明本月内实际支出的经费与计划相比较，是超过了。相符合、还是不到计划数？如果与计划不一致，说明原因及准备采取的措施。5下个月的工作计划6建议本月遇到的重要问题和应引起重视的问题以及因此产生的建议。1引言11.1编写目的11.2背景11.3定义11.4参考资料12可行性研究的

9、前提22.1要求22.2目标22.3条件、假定和限制32.4进行可行性研究的方法32.5评价尺度33对现有系统的分析33.1处理流程和数据流程43.2工作负荷43.3费用开支43.4人员43.5设备43.6局限性44所建议的系统44.1对所建议系统的说明54.2处理流程和数据流程54.3改进之处54.4影响5对设备的影响5对软件的影响5对用户单位机构的影响5对系统运行过程的影响6对开发的影响6对地点和设施的影响6对经费开支的影响64.5局限性64.6技术条件方面的可行性75可选择的其他系统方案75.1可选择的系统方案175.2可选择的系统方案276投资及效益分析76.1支出7基本建设投资8其他

10、一次性支出8非一次性支出86.2收益9一次性收益9非一次性收益9不可定量的收益96.3收益投资比106.4投资回收周期106.5敏感性分析107社会因素方面的可行性107.1法律方面的可行性107.2使用方面的可行性108结论11GB856788可行性研究报告1引言1.1编写目的说明编写本可行性研究报告的目的，指出预期的读者。1.2背景说明：A. 所建议开发的软件系统的名称；B. 本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；C. 该软件系统同其他系统或其他机构的基本的相互来往关系。1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出用得

11、着的参考资料，如：1. 本项目的经核准的计划任务书或合同、上级机关的批文；2. 属于本项目的其他已发表的文件；3. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2可行性研究的前提说明对所建议的开发项目进行可行性研究的前提，如要求、目标、假定、限制等。2.1要求说明对所建议开发的软件的基本要求，如：A. 功能；B. 性能；C. 输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象；D. 输入说明系统的输入，包括数据的来源、类型、数量、数据的组织以及提供的频度；E. 处

12、理流程和数据流程用图表的方式表示出最基本的数据流程和处理流程，并辅之以叙述；F. 在安全与保密方面的要求；G. 同本系统相连接的其他系统；H. 完成期限。2.2目标说明所建议系统的主要开发目标，如：A. 人力与设备费用的减少；B. 处理速度的提高；C. 控制精度或生产能力的提高；D. 管理信息服务的改进；E. 自动决策系统的改进；F. 人员利用率的改进。2.3条件、假定和限制说明对这项开发中给出的条件、假定和所受到的限制，如：a 所建议系统的运行寿命的最小值；b 进行系统方案选择比较的时间；c 经费、投资方面的来源和限制；d 法律和政策方面的限制；e 硬件、软件、运行环境和开发环境方面的条件和

13、限制；f 可利用的信息和资源；g 系统投入使用的最晚时间。2.4进行可行性研究的方法说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所使用的基本方法 和策略，如调查、加权、确定模型、建立基准点或仿真等。2.5评价尺度说明对系统进行评价时所使用的主要尺度，如费用的多少、各项功能的优先次序、开发时间的长短 及使用中的难易程度。3对现有系统的分析这里的现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚 至是一个人工系统。分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。3.1处理流程和数据流程说明现有系统的基本的处理流程和

14、数据流程。此流程可用图表即流程图的形式表示，并加以叙述。3.2工作负荷列出现有系统所承担的工作及工作量。3.3费用开支列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支以及开 支总额。3.4人员列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。3.5设备 列出现有系统所使用的各种设备。3.6局限性列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力不足，处理功能 不够等。并且要说明，为什么对现有系统的改进性维护已经不能解决问题。4所建议的系统本章将用来说明所建议系统的目标和要求将如何被满足。4.1对所建议系统的说明概括地说明所建

15、议系统，并说明在第2章中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。4.2处理流程和数据流程给出所建议系统的处理流程和数据流程。4.3改进之处按2.2条中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。4.4影响说明在建立所建议系统时，预期将带来的影响，包括：对设备的影响说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。对软件的影响说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所进行的修改和补充。对用户单位机构的影响说明为了建立和运行所建议系统，对用户单位机构、人员的数量和技术水平等方面的全部要求。对系统运行过程的影响说明所建议

16、系统对运行过程的影响，如：a 用户的操作规程；b 运行中心的操作规程；c 运行中心与用户之间的关系；d 源数据的处理；e 数据进入系统的过程；f 对数据保存的要求，对数据存储、恢复的处理；g 输出报告的处理过程、存储媒体和调度方法；h 系统失效的后果及恢复的处理办法。对开发的影响说明对开发的影响，如：a. 为了支持所建议系统的开发，用户需进行的工作；b. 为了建立一个数据库所要求的数据资源；c. 为了开发和测验所建议系统而需要的计算机资源；d. 所涉及的保密与安全问题。对地点和设施的影响说明对建筑物改造的要求及对环境设施的要求。对经费开支的影响扼要说明为了所建议系统的开发，设计和维持运行而需要

17、的各项经费开支。4.5局限性 说明所建议系统尚存在的局限性以及这些问题未能消除的原因。4.6技术条件方面的可行性本节应说明技术条件方面的可行性，如：a 在当前的限制条件下，该系统的功能目标能否达到；b 利用现有的技术，该系统的功能能否实现；c 对开发人员的数量和质量的要求并说明这些要求能否满足；d 在规定的期限内，本系统的开发能否完成。5可选择的其他系统方案扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和可从国内国外直接购买的，如果没有供选择的系统方案可考虑，则说明这一点。5.1可选择的系统方案1参照第4章的提纲，说明可选择的系统方案1，并说明它未被选中的理由。5.2可选择的系统方案2

18、按类似5.1条的方式说明第2个乃至第n个可选择的系统方案。.6投资及效益分析 6.1支出对于所选择的方案，说明所需的费用。如果已有一个现存系统，则包括该系统继续运行期间所需的费用。基本建设投资包括采购、开发和安装下列各项所需的费用，如：a. 房屋和设施；b. ADP设备；c. 数据通讯设备；d. 环境保护设备；e. 安全与保密设备；f. ADP操作系统的和应用的软件；g. 数据库管理软件。其他一次性支出包括下列各项所需的费用，如：a 研究（需求的研究和设计的研究）；b 开发计划与测量基准的研究；c 数据库的建立；d ADP软件的转换；e 检查费用和技术管理性费用；f 培训费、旅差费以及开发安装

19、人员所需要的一次性支出；g 人员的退休及调动费用等。非一次性支出列出在该系统生命期内按月或按季或按年支出的用于运行和维护的费用，包括：a 设备的租金和维护费用；b 软件的租金和维护费用；c 数据通讯方面的租金和维护费用；d 人员的工资、奖金；e 房屋、空间的使用开支；f 公用设施方面的开支；g 保密安全方面的开支；h 其他经常性的支出等。6.2收益对于所选择的方案，说明能够带来的收益，这里所说的收益，表现为开支费用的减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等，包括；一次性收益说明能够用人民币数目表示的一次性收益，可按数据处理、用户、管理和支持等项分类叙述，如：a

20、 开支的缩减包括改进了的系统的运行所引起的开支缩减，如资源要求的减少，运行效率的改进，数据进入、存贮和恢复技术的改进，系统性能的可监控，软件的转换和优化，数据压缩技术的采用，处理的集中化分布化等；b 价值的增升包括由于一个应用系统的使用价值的增升所引起的收益，如资源利用的改进，管理和运行效率的改进以及出错率的减少等；c 其他如从多余设备出售回收的收入等。非一次性收益说明在整个系统生命期内由于运行所建议系统而导致的按月的、按年的能用人民币数目表示的收益，包括开支的减少和避免。不可定量的收益逐项列出无法直接用人民币表示的收益，如服务的改进，由操作失误引起的风险的减少，信息掌握情况的改进，组织机构给

21、外界形象的改善等。有些不可捉摸的收益只能大概估计或进行极值估计（按最好和最差情况估计）。6.3收益投资比求出整个系统生命期的收益投资比值。6.4投资回收周期求出收益的累计数开始超过支出的累计数的时间。6.5敏感性分析所谓敏感性分析是指一些关键性因素如系统生命期长度、系统的工作负荷量、工作负荷的类型与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时，对开支和收益的影响最灵敏的范围的估计。在敏感性分析的基础上做出的选择当然会比单一选择的结果要好一些。7社会因素方面的可行性本章用来说明对社会因素方面的可行性分析的结果，包括：7.1法律方面的可行性法律方面的可行性问题很多，如合同责任

22、、侵犯专利权、侵犯版权等方面的陷井，软件人员通常是不熟悉的，有可能陷入，务必要注意研究。7.2使用方面的可行性例如从用户单位的行政管理、工作制度等方面来看，是否能够使用该软件系统；从用户单位的工作人员的素质来看，是否能满足使用该软件系统的要求等等，都是要考虑的。8结论在进行可行性研究报告的编制时，必须有一个研究的结论。结论可以是：a 可以立即开始进行；b 需要推迟到某些条件（例如资金、人力、设备等）落实之后才能开始进行；c 需要对开发目标进行某些修改之后才能开始进行；d 不能进行或不必进行（例如因技术不成熟、经济上不合算等）。数据库设计说明1引言21.1编写目的21.2背景21.3定义21.4

23、参考资料22外部设计22.1标识符和状态22.2使用它的程序32.3约定32.4专门指导32.5支持软件33结构设计33.1概念结构设计33.2逻辑结构设计33.3物理结构设计44运用设计44.1数据字典设计44.2安全保密设计4数据库设计说明书（GB856788）1引言1.1编写目的说明编写这份数据库设计说明书的目的，指出预期的读者。1.2背景说明：a 说明待开发的数据库的名称和使用此数据库的软件系统的名称；b 列出该软件系统开发项目的任务提出者、用户以及将安装该软件和这个数据库的计算站（中心）。1.3定义列出本文件中用到的专门术语的定义、外文首字母组词的原词组。1.4参考资料列出有关的参考

24、资料：a 本项目的经核准的计划任务书或合同、上级机关批文；b 属于本项目的其他已发表的文件；c 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。2外部设计2.1标识符和状态联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。2.2使用它的程序列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。2.3约定陈述一个程序员或一个系统分析员为了能使用此数据

25、库而需要了解的建立标号、标识的约定，例如用于标识数据库的不同版本的约定和用于标识库内各个文卷、记录、数据项的命名约定等。2.4专门指导向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导，例如将被送入数据库的数据的格式和标准、送入数据库的操作规程和步骤，用于产生、修改、更新或使用这些数据文卷的操作指导。如果这些指导的内容篇幅很长，列出可参阅的文件资料的名称和章条。2.5支持软件简单介绍同此数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修 改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性，如所用数据模型的类型、允许 的数据容量等。列出这

26、些支持软件的技术文件的标题、编号及来源。3结构设计3.1概念结构设计说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式，包括各数据项、记录、系、文卷的标识符、定义、类型、度量单位和值域，建立本数据库的每一幅用户视图。3.2逻辑结构设计说明把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构和文卷结构、所建立的各个文卷之间的相互关系，形成本数据库的数据库管理员视图。3.3物理结构设计建立系统程序员视图，包括：a 数据在内存中的安排，包括对索引区、缓冲区的设计；b 所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分；c 访问数据的方式方法。4运用设计4.1数据字典设计对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷、模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。在本节中要说明对此数据字典设计的基本考虑。4.2安全保密设计说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。