《附录c 软件开发文档指南》由会员分享,可在线阅读,更多相关《附录c 软件开发文档指南(11页珍藏版)》请在金锄头文库上搜索。
1、附录 C软件开发文档指南1可行性研究报告可行性研究报告的编写目的是:说明该软件开发项目的实现在技术、经济和社会条件方面的可行性;评述为了合理地达到开发目标而可能选择的各种方案;说明论证所选定的方案。可行性研究报告的编写内容要求如下:1.1引言1.1.1编写目的1.1.2背景1.1.3定义1.1.4参考资料1.2可行性研究的前提 1.2.1要求1.2.2目标1.2.3条件、假定和限制1.2.4进行可行性研究的方法1.2.5评价尺度1.3对现有系统的分析1.3.1数据流程和处理流程1.3.2工作负荷1.3.3费用开支1.3.4人员1.3.5设备1.3.6局限性1.4所建议的系统1.4.1对所建议系
2、统的说明1.4.2数据流程各处理流程1.4.3改进之处1.4.4影响1.4.4.1对象设备的影响1.4.4.2对软件的影响1.4.4.3对用户单位机构的影响1.4.4.4对系统动行的影响1.4.4.5对开发的影响1.4.4.6对地点和设施的影响1.4.4.7对经费开支的影响1.4.5局限性1.4.6技术条件方面的可行性1.5可选择其他系统方案1.5.1可选择的系统方案 11.5.2可选择的系统方案 21.6投资及收益分析1.6.1支出1.6.1.1基本建设投资1.6.1.2其他一次性支出1.6.1.3非一次性支出1.6.2收益1.6.2.1一次性收益1.6.2.2非一次性收益1.6.2.3不可
3、定量的收益1.6.3收益/投资比1.6.4投资回收周期1.6.5敏感性分析1.7社会条件方面的可行性1.7.1法律方面的可行性1.7.2使用方面的可行性1.8结论2项目开发计划编制项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来,以便根据本计划开展和检查本项目的开发工作。编制内容要求如下:2.1引言2.1.1编写目的2.1.2背景2.1.3定义2.1.4参考资料2.2项目概述2.2.1工作内容2.2.2主要参加人员2.2.3产品及成果2.2.3.1程序2.2.3.2文件2.2.3.3服务2.2.3.4非移交产品
4、2.2.4验收标准2.2.5完成项目的最迟期限2.2.6本计划的审查者与批准者2.3实施总计划2.3.1工作任务的分解2.3.2接口人员2.3.3进度2.3.4预算2.3.5关键问题2.4支持条件2.4.1计算机系统支持2.4.2需要用户承担的工作2.4.3需由外单位提供的条件2.5专题计划要点3软件需求说明书软件需求说明书的编制是为了使用户和软件开发者双方对该软件的起初规定有一个共同的理解,使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下:3.1引言3.1.1编写的目的3.1.2背景3.1.3定义3.1.1参考资料 3.2任务概述3.2.1目标3.2.2用户的特点3.2.3假定与
5、约束3.3需求规定 3.3.1对功能的规定3.3.2对性能的规定3.3.2.1精度3.3.2.2时间特性要求3.3.2.3灵活性3.3.3输入输出要求3.3.4数据管理能力的要求3.3.5故障处理要求3.3.6其它的专门的要求3.4运行环境规定3.4.1设备3.4.2支持软件3.4.3接口3.4.4控制4数据需求说明书数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下:4.1引言4.1.1编写目的4.1.2背景4.1.3定义4.1.4参考资料4.2数据的逻辑描述4.2.1静态数据4.2.2动态输入数据4.2.3动态输出数
6、据4.2.4内部生成数据4.2.5数据约定4.3数据的采集4.3.1要求和范围4.3.2输入的承担者4.3.3处理4.3.4影响5概要设计说明书概要设计说明书可称作系统设计说明书,这里说的系统是指程序系统,编制的目的是说明对程序的系统的设计考虑,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。编制概要设计说明书的内容要求如下:5.1引言5.1.1编写目的5.1.2背景5.1.3定义5.1.4参考资料5.2总体设计5.2.1需求规定5.2.2运行环境5.2.3基本设计概念和处理流程5.2.4结构5.2
7、.5功能需求与程序的关系5.2.6人工处理过程5.2.7尚未解决的问题5.3接口设计5.3.1用户接口5.3.2内部接口5.3.3外部接口5.4运行设计5.4.1运行模块组合5.4.2运行控制5.4.3运行时间5.5系统数据结构设计5.5.1逻辑结构设计要点5.5.2物理结构设计要点5.5.3数据结构与程序的关系5.6系统出错处理设计5.6.1出错信息5.6.2补救措施5.6.3系统维护设计6详细设计说明书详细说明书可称作程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑,如果一个软件系统比较简单,层次很少,本文件可以不单独编写,有关内容合并概要设计
8、说明书。对详细设计说明书的内容要求如下:6.1引言6.1.1 编写目的6.1.2 背景6.1.3 定义6.1.4 参考资料6.2 程序系统的组织结构6.3 程序 1(标识符)设计说明6.3.1 程序描述6.3.2 功能6.3.3 性能6.3.4 输入项6.3.5 输出项6.3.6 算法6.3.7 流程逻辑6.3.8 接口6.3.9 存储分配6.3.10 注释设计6.3.11 限制条件6.3.12 测试计划6.3.13 尚未解决的问题6.4 程序 2(标识符)设计说明7数据库设计说明书数据库设计说明书的编制目的是对于设计中的数据库所有标识、逻辑结构和物理结构作出具体的设计规定。其内容要求如下:7
9、.1引言7.1.1编写目的7.1.2背景7.1.3定义7.1.4参考资料7.2外部设计7.2.1标识符和状态7.2.2使用它的程序7.2.3约定7.2.4专门指导7.2.5支持软件7.3结构设计7.3.1概念结构设计7.3.2逻辑结构设计7.3.3物理结构设计7.4运用设计7.4.1数据字典设计7.4.2安全保密设计8用户手册用户手册的编制是要使用非专门术语的语言,充分地描述该软件系统工程所具有的功能及基本的使用方法。使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下,如何使用它。具体的内容要求如下:8.1引言8.1.1编写目的8.1.2背景8.1.3定义8.1.4参
10、考资料8.2用途8.2.1功能8.2.2性能8.2.2.1精度8.2.2.2时间特性8.2.2.3灵活性8.2.3安全保密8.3运行环境8.3.1硬设备8.3.2支持软件8.3.3数据结构8.4使用过程8.4.1安装与初始化8.4.2输入8.4.2.1输入数据的现实背景8.4.2.2输入格式8.4.2.3输入举例8.4.3输出8.4.3.1输出数据的现实背景8.4.3.2输出格式8.4.3.3输出举例8.4.4文卷查询8.4.5出错处理与恢复8.4.6终端操作9操作手册操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识,包括操作方法的细节。具体的内容要求如下:9.1引言9.
11、1.1编写目的9.1.2背景9.1.3定义9.1.2参考资料9.2软件概述9.2.1软件的结构9.2.2程序表9.2.3文卷表9.3安装与初始化9.4运行说明9.4.1运行表9.4.2运行步骤9.4.3运行 1(标识符)说明9.4.3.1运行控制9.4.3.2操作信息9.4.3.3输入-输出文卷9.4.3.4输出文段9.4.3.5输出文段的复制9.4.3.6启动恢复过程9.4.4运行 2(标识符)说明9.5非常规过程9.6远程操作10模块开发卷宗模块开发卷宗是在模块开发过程中逐步编写出来的,每完成一个模块或一级密切相关的模块的复审时编写一份,应该把所有的模块开发卷宗汇集在一起。编写的目的是记录
12、和汇总低层次开发的进度和结果,以便于对整个模块开发工作的管理和复审,并为将来的维护提供非常有用的技术信息。具体的内容要求如下:10.1标题10.2模块开发情况表10.3功能说明10.4设计说明10.5源代码清单10.6测试说明10.7复审的结论11测试计划11.1引言11.1.1编写目的11.1.2背景11.1.3定义11.1.4参考资料11.2计划11.2.1软件说明11.2.2测试内容11.2.3测试 1(标识符)11.2.3.1进度安排11.2.3.2条件11.2.3.3测试资料11.2.3.4测试培训11.2.4测试 2(标识符)11.3测试设计说明11.3.1测试 1(标识符)11.
13、3.1.1控制11.3.1.2输入11.3.1.3输出11.3.1.4过程11.3.2测试 2(标识符)11.4评价准则11.5.1范围11.4.2数据整理11.4.3尺度12测试分析报告测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载,具体的编写内容要求如下:12.1引言12.1.1编写目的12.1.2背景12.1.3定义12.1.4参考资料12.2测试概要12.3测试结果及发现12.3.1测试 1(标识符)12.3.2测试 2(标识符)12.4对软件功能的结论12.4.1功能 1(标识符)12.4.1.1能力12.4.1.2限制12.4.2功能 2(标识符)1
14、2.5分析摘要13.5.1能力12.5.2缺陷和限制12.5.3建议12.5.4评价12.6测试资源消耗13开发进度月报开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情况,以便能及时发现或处理开发过程中出现的问题。一般地,开发进度月报是以项目组为单位每月编写的。如果被开发的软件系统规模比较大,整个工程项目被划分给若干个分项目组承担,开发进度月报将以项目组为单位按月编写。具体的内容要求如下:13.1标题13.2工程进度与状态13.2.1进度13.2.2状态13.3资源耗用与状态13.3.1资源耗用13.3.1.1工时13.3.1.2机时13.3.2状态13.4经费支出与状态 13.4.1经费支出13.4.1.1支持性费用13.4.1.2设备购置费13.4.2状态13.5下个月的工作计划13.6建议14项目开发总结报告项目开发总结报告的编制是为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价。具体的内容要求如下:14.1引言14.1.1编写目的14.1.2背景14.1.3定义14.1.4参考资料14.2实际开发结果14.2.1产品14.2.2主要功能和性能14.2.3基本流程14.2.4进度14.2.5费用14.3开发工作评价14.3.1对生产率的评价14.3.2对产品质量的评价14.3.3对技术方法的评价14.3.4出错原因的分析