1.前言:
这段时间结合机房收费系统对文档的编写进行了学习,可能是由于之前没有接触过文档编写的相关知识,写起来感觉特别费劲,都不知道怎么去描述各部分的内容。结合文档的样本站在巨人的肩膀上一步步的“艰难的”前行。慢慢的通过查阅资料,看的多了就对各个阶段的文档有了一定的了解。通过写文档我个人感觉只有结合实际的例子写的多了才能更加熟练。在此之前我们要弄明白,每个阶段要产生什么文档?为什么要写相应的文档?每个文档里又要包含写什么?
2.各阶段文档:
2.1可行性研究报告:
目的:说明软件开发项目的实现在技术上、经济上和社会条件上的可行性;论述为达到开发目的而可能选择的各种方案;说明并论证所选定的方案。
内容:
1.引言:(编写目的、背景、定义、参考资料等);
2.可行性研究的前提:(要求、目标、条件、假定、限制、进行可行性研究的方法、评价尺度);3-对现有系统的分析(数据流程和处理流程、工作负荷、费用开支、人员、设备、局限性);
3.所建议的系统:(对该系统的说明、数据流程和处理流程、改进之处、影响、局限性、技术条件方面的可行性)
4.可选择的其它系统方案;
5.投资以及收益分析:(支出、收益、收益/投资比、投资回收周期、敏感性分析);
6.社会条件方面的可行性:(法律方面的可行性,使用方面的可行性);
7 .结论。
2.2项目开发计划:
目的:将开发过程中有关各项工作的负责人员、开发进度、经费预算、软硬件等问题做出的安排记载下来,以便根据本计划开展和检查本项目的开发工作。
内容:
1.引言:( 编写目的、背景、定义、参考资料等);
2.项目概述:(工作内容、主要参加人员、产品、验收标准、完成项目的最迟期限、本计划的批准者和日期);
3.实施计划:(工作任务的分解与人员分工、接口人员、进度、预算、关键问题);
4.支持条件:(计算机系统的支持、用户承担的工作、外单位提供的条件);
5.专题计划要点。
2.3软件需求说明书:
目的:使用户和软件开发者双方对软件的初始规定有一个共同的理解,使之成为整个开发工作的基础。
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.任务概述:(目标、用户的特点、假定与约束);
3.需求规定:(对功能/性能的规定、输入输出要求、数据管理能力要求、故障处理要求、其他专门要求);
4.运行环境规定:(设备、支撑软件、接口、控制)。
2.4概要设计说明书:
目的:说明对程序系统的设计考虑,为程序的详细设计提供基础。
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.总体设计:(需求规定、运行环境、基本设计概念和处理流程、结构、功能需求和程序的关系、人工处理过程、尚未解决的问题);
3.接口设计:(用户接口、外部接口、内部接口);
4.运行设计:(运行模块组合、运行控制、运行时间);
5.系统数据结构设计:(逻辑、物理、数据结构设计要点);
6.系统出错处理设计:(出错信息、补救措施、系统维护设计);
2.5详细设计说明书:
目的:说明一个软件系统各个层次的每一个程序(每个模块或者子程序)的设计考虑。
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2. 程序系统的组织结构;
3.各程序:(标识符)设计说明。
注意:如果软件系统比较简单、层次很少,也可不必单独编写“详细设计说明书”,有关内容可以并入总体设计说明书。
注意:如果软件系统比较简单、层次很少,也可不必单独编写“详细设计说明书”,有关内容可以并入总体设计说明书。
2.6.1数据设计说明书:
目的:对于设计中的数据库的所有标识符、逻辑结构和物理结构做出具体的设计规定。
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.外部设计:(标识符和状态、使用它的程序、约定、专门指导、支撑软件);
3.结构设计:(概念、逻辑和物理结构设计);
4.运用设计:(数据字典设计、安全保密设计);
2.6.2数据要求所明书:
目的:向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.数据的逻辑描述:(静态数据、动态输入数据、动态输出数据、内部生成数据、数据约定);
3.数据的采集:(要求和范围、输入的承担者、预处理、影响)。
2.7测试计划:
目的:提供对该软件的测试计划 。
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.计划:(软件说明、测试内容、各项测试);
3.测试设计说明书:(各测试的控制、输入、输出、过程等);
4.评价准则:(范围、数据整理、尺度)。
2.8测试分析报告:
目的:把集成测试和确认测试的结果、发现以及分析写成文件家以记载。
内容:
1.引言:(编写目的、背景、定义、参考资料);
2.测试概要;
3.测试结果以及发现:(不同的测试);
4.对软件功能的结论:(各功能的能力、限制);
5.分析摘要:(能力、缺陷和限制、建议、评价);
6.测试资源消耗。
2.9项目开发总结报告:
目的:总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价。
内容:
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.实际开发结果:(产品、主要功能和性能、基本流程、进度、费用);
3.开发工作评价:(对生产效率、产品质量和技术方法的评价,出错原因的分析);
4.经验和教训。
2.10操作手册:
目的:向操作人员提供该软件每一个运行的具体过程的有关知识,包括操作方法的细节。
内容:
内容:
1.引言:( 编写目的、前景、定义、参考资料);
2.软件概述:(软件的结构、程序表、文卷表);
3.安装与初始化;
4.运行说明:(运行表、运行步骤、各个说明-运行控制、操作信息、输入输出文卷、输出文段、输出文段的复制、恢复过程);
5.非常规过程;
6.远程操作;
2.11用户手册:
目的:使用非专门术语,充分描述该软件系统所具有的功能以及基本的使用方法,使用户了解该软件的用途,正确使用它。
内容:
内容:
1.引言:( 编写目的、背景、定义、参考资料);
2.用途:(功能,性能-精度、时间特性、灵活性,安全保密);
3.运行环境:(硬件设备、支撑软件、数据结构);
4.使用过程:(安装与初始化,输入-输入数据的现实背景、输入格式、输入举例,输出,文卷查询,出错处理与恢复、终端操作)。
2.12开发进度月报:
目的:及时向有关管理部门汇报项目开发的进度和情况,以便及时发现和处理开发过程中出现的问题。
内容:
内容:
1.标题;
2.工程进度与状况:(进度、状况);
3.资源耗用与状态:(工时、机时、状态);
4.经费支出与状态:(支持性费用、设备购置费用,状态);
5.下个月的工作计划;
6.建议;
3.总结:
软件文档也称文件,通常指的是一些记录的数据 和数据媒体,它具有固定不变的形式,可被人和计算机阅读。它和 计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道,硬件产品和产品资料在整 个生产过程中都是有形可见的,软件生产则有很大不同,文档本 身就是软件产品。没有文档的软件,不成其为软件,更谈不到软件 产品。软件文档的编制在软件开发工作中占有突 出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软 件产品的效益有着重要意义。