关于软件文档的技术要求

                关于软件开发计划的制定

1. 软件开发计划制定的目的。

   软件开发计划是为了控制软件各开发阶段的工作进度。软件开发计划是以明确的目标为出发的。

 

2. 软件开发计划制定的基本要素。

   包括项目名称 开始时间 结束时间 项目担当人 项目开工的条件和完成标志。

 

3．软件开发计划制定的要求。

  （1）软件开发计划的制定要体现的软件开发的阶段性特征。

  （2）软件开发计划的制定要体现的软件开发的连续性特征。

  （3）项目比较大时可以将计划分成项目总体计划和分项详细计划。

  （4）项目因故延期或提前应制订项目调整计划，并应讲明原因。项目调整计划从当前开始。

 

4．软件开发计划的检查。

   项目经理对软件项目开发计划每周应至少检查一次，每周将项目进度报有关领导。

 

5．制订项目开发计划使用的软件工具。

使用 MS  PROJECT   。

 

6． 应用软件开发项目在项目启动时应该有一个初步计划，在项目进展过程中应该将计划细化。一般计划应包括如下几大项，并根据实际情况做增删。对于每一个目标都要有阶段文档，否则认为没完成。

（1）系统可行性分析；

（2）系统立项；

（3）需求分析讨论和确定；

（4）系统概要设计；

（5）系统详细设计；

（6）系统编程；

（7）用户手册、中心维护手册编制；

（8）技术测试；

（9）用户测试；

（10）用户培训；

（11）系统正式运行；

（12）系统验收。

 

 

 

 

 

应用开发阶段性工作文档的技术要求

一．    需求分析文档技术要求

 

       需求分析文档的编写应包括下列各项：

1．  项目的开发目的，预期效果，提出单位，供使用单位。

 

2．  功能描述：

（1）            功能划分。

（2）            功能描述。

 

3．  数据处理的简要流程。

 

4．  用户输入界面的画面格式：

（1）            包括数据项目，数据类型，长度

（2）            画面设计。

 

5．  输出界面：

（1）            画面输出：

   画面设计。

   查询的关键字。

   画面的内容。

（2）            报表输出：

   输出的周期。

   报表格式。

 

6．  校验与标准：

（1）            校验要求。

（2）            引用标准。

 

7．  数据量估算：

（1）            包括存放时间周期。

（2）            单位周期的数据量。

（3）            超期数据的处理要求。

 

8．  若存在数据内外交换则应明确：

（1）            数据内外交换使用的方式。

（2）            交换的频率。

（3）            交换的数据量/单位时间。

9．  其他要求。

 

二 . 系统概要设计的文档技术要求

 

1．系统开发和运行的软硬件环境

（1）    系统开发环境的要求

l        硬件环境

l        支持的操作系统

l        网络环境

l        使用的开发语言，工具，数据库

 软件应描述清楚使用的版本；

 硬件应指明空间需求，若需服务器则应对服务器的指标提出要求。

（2）    系统运行的环境的要求

除开发环境的要求外应描述 :

①    数据空间的要求，存储周期

②    数据后备的策略（包括软件备份，数据异地保存，备份周期，备份介质，备份由那个部分负责，开发部以何种方式通知备份，备份数据的检查制度，等）

③    运行后的系统维护策略

软件运行出错，及需求更改的报告流程，软件维护的记录及保存方法，软件版本的管理要求

 

2．系统数据的处理详细流程描述

（1）    输入流程描述

以输入、校验、运算或处理、保存来描述输入流，以数据流图来表示

（2）    输出流程描述

以输出要求，对文件或数据库抽取的要求，数据加工要求，输出，来描述输出流

 

3．子系统划分

若系统规模较大则应将系统划分成若干独立的子系统

（1）    子系统划分的基本准则

（2）    各子系统的基本功能

（3）    各子系统的处理流程

 

4．系统约定

（1）    系统命名准则

包括：子系统，程序，作业名，模块，文件，数据库，字段

（2）    系统所使用的代码一览表（包括参考那些系统的代码）

（3）    系统约定的管理办法

 

5．系统接口文件描述

（1）    若系统由子系统，应描述接口文件的字段

（2）    若和其他系统由接口则应描述接口文件个数，每个文件的字段，生成的周期，保存及后备恢复的要求，由何人生成等

6．系统测试大纲

（1）    测试方法

（2）    测试内容

l        描述需测试的内容，数据准备要求，预计的测试结果（正确或出错）

l        数据准备应包括正确和错误的两大类

l        以功能或数据处理为单位进行测试

（3）  测试工具

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

三．系统详细设计的文档技术要求

 

1．系统数据字典

应包括字段名，属性，长度，字段中文含义（用电子数据格式记录）

 

2．文件设计，数据库设计

（1）    文件一览表

（2）    数据库表一览

（3）    文件及数据库表的详细描述

 

3．程序设计

（1）    程序一览表（以子系统为单位）

（2）    程序输入，处理，输出的描述，及功能描述

（3）    程序调用的模块及层次图

 

4．公用模块的设计（有两个以上程序需调用的模块）

（1）    模块一览表（以系统为单位）

（2）    模块的功能

（3）    调用的方式及条件

（4）    调用的返回结果

（5）    模块的基本算法

（6）    调用外系统的模块一览表

应指明模块名，所属系统，调用方式，条件，返回的结果

 

5．系统出错处理设计

（1）    需进行恢复处理的出错一览表

（2）    各种出错后，系统恢复的步骤及数据丢失的最大可能分析

（3）    各恢复处理的流程（以作业步，程序为单位详细明列）

 

6．系统后备的设计

（1）    软件备份设计

（2）    数据备份设计

（3）    软件版本管理

 

7．系统保密设计

（1）    系统采取的保密措施

（2）    用户权限管理

（3）    软件开发人员的权限管理（指开发时和维护两种不同工况）

 

 

 

 

 

四．系统技术测试的文档技术要求

 

1．技术测试概论

（1）    测试目的，任务，测试内容

（2）    参加测试人员及时间

（3）    测试方法，步骤

（4）    预期达到的目标

 

2．测试环境的软，硬件环境

（1）    硬件环境

（2）    支持的操作系统

（3）    网络环境

（4）    开发工具，语言，数据库

 

3．测试数据的准备

 

4．技术测试的计划及结果

       包括任务，目的，测试人员，时间安排，完成时间，测试结果

 

4．测试结果分析

与测试大纲进行对比、分析

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

项目开发总结文档技术要求

 

 一．项目开发概述。

     1．项目开发的目的，立项过程

     2．需求的确认：概述需求的提出至需求的确认的过程。

     3．软件开发的环境。

     4．开发的简要过程。

     5．项目验收的概况。

     6．交付使用的起始日期。

 

 二．项目的主要功能。

 

 三．项目开发的主要成员及各自主要完成的任务。

 

 四．项目交付使用的实际效果分析。

 

 五．项目推广应用的价值分析。

 

 六．项目维护的联系人员，通讯地址，电话。

 

 七．用户的权限的管理的归属部门，联系人员，通讯地址，电话。

     权限的审批程序。

 

 八．系统维护，后备的管理制度。