小组成员通过对软件项目文档编写标准资料的查找，将软件项目文档分为14种：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、数据库设计说明书、用户手册、操作手册、模块开发卷宗、软件测试计划、软件测试分析报告、项目开发进度月报、项目开发总结报告。

项目文档的基本结构为：

图 1 项目文档基本结构

以下为14种教育软件项目文档的具体编写标准：

1. 引言

     1.1 编写目的

     1.2 背景

     1.3 定义      

     1.4 参考资料

 2. 可行性研究的前提

     2.1 要求

     2.2 目标

     2.3 条件、假定和限制

     2.4 进行可行性研究的方法

     2.5 评价尺度

 3. 对现有系统的分析

     3.1 处理流程和数据流程

     3.2 工作负荷

     3.3 费用开支

     3.4 人员

     3.5 设备

     3.6 局限性

 4. 所建议的系统

     4.1 对所建议系统的说明

     4.2 处理流程和数据流程

     4.3 改进之处

     4.4 影响

           4.4.1.对设备的影响

           4.4.2.对软件的影响

           4.4.3.对用户单位机构的影响

           4.4.4.对系统运行过程的影响

           4.4.5.对开发的影响

           4.4.6.对地点和设施的影响

           4.4.7.对经费开支的影响

     4.5 技术条件方面的可能性

5. 可选择的其他系统方案

     5.1 可选择的系统方案1

     5.2 可选择的系统方案2

6. 投资及效益分析

     6.1 支出

           6.1.1 基本建设投资

           6.1.2 其他一次性支出

           6.1.3 非一次性支出

      6.2 收益

           6.2.1 一次性收益

           6.2.2 非一次性收益

           6.2.3 不可定量的收益

      6.3 收益/投资比

      6.4 投资回收周期

      6.5 敏感性分析

7. 社会因素方面的可能性

      7.1.法律方面的可行性

      7.2.使用方面的可行性

8. 结论

1.引言

      1.1编写目的

      1.2项目简介

           1.2.1项目名称

           1.2.2产品标识

           1.2.3项目背景

      1.3定义

      1.4参考资料

2.项目概述

      2.1工作内容

      2.2交付项

      2.3非交付项

      2.4项目进度和资源

      2.5其他需求与约束

3.项目组织和资源

      3.1项目组织

      3.2项目资源

           3.2.1人力资源

图 2 人力资源列表

           3.2.2已有开发设施

           3.2.3须获取的设施

           3.2.4可复用软件资源

4.实施计划

      4.1项目选用的生命周期

      4.2项目开发过程阶段划分

图 3 项目开发过程的阶段划分

      4.3项目工作任务分解

图 4 任务分解

      4.4进度

           4.4.1进度安排

           4.4.2进度控制计划

      4.5接口人员

      4.6关键问题

图 5 风险关键问题

5.专题计划要点

      5.1基础技术积累计划

      5.2测试计划

测试阶段分解：

图 6 测试计划

      5.3配置计划

           5.3.1组织、职责和接口

           5.3.2工具、环境和基础设施

           5.3.3标识方法

      5.4评审计划

图 7 评审计划

      5.5质量保证计划

图 8 质量保证计划

      5.6培训计划

图 9 培训计划

      5.7系统安装计划

1.引言

      1.1目的

      1.2定义

      1.3参考资料

2.软件总体概述

      2.1软件标识

      2.2软件描述

           2.2.1系统属性

           2.2.2开发背景

           2.2.3软件功能

图 10 软件功能

      2.3用户的特点

      2.4限制与约束

3.具体需求

      3.1功能需求

图 11 功能需求

      3.2性能需求

      3.3数据库需求

      3.4设计约束

           3.4.1其他标准的约束

           3.4.2硬件约束

      3.5属性

           3.5.1可用性

           3.5.2可靠性

           3.5.3效率

           3.5.4安全性

           3.5.5可维护性

           3.5.6可移植性

      3.6外部接口需求

           3.6.1用户接口

           3.6.2硬件接口

           3.6.3软件接口

           3.6.4通信接口

1．引言

      1.1编写目的

      1.2背景

      1.3定义

      1.4参考资料

2．数据的逻辑描述

      2.1静态数据

      2.2动态输入数据

      2.3动态输出数据

      2.4内部生成数据

      2.5数据约定

3．数据的采集

      3.1要求和范围

      3.2输入的承担者

      3.3预期处理

      3.4影响

1.引言

      1.1编写目的

      1.2定义

      1.3参考资料

2.范围

      2.1系统主要目标

      2.2主要软件需求

      2.3设计约束、限制

3.软件系统结构设计

      3.1复审数据流、控制流

      3.2软件体系结构

           3.2.1软件程序结构图

           3.2.2模块命名规则

           3.2.3模块描述

       可用IPO图结合下表对每一软件模块进行描述。

图 12 IPO列表

      3.3功能需求追溯

      3.4复用策略

4.数据设计

      4.1数据字典复审

      4.2数据项

      4.3数据库结构设计

      4.4数据结构与程序的关系

      4.5文件设计

5.接口设计

      5.1用户界面设计规则

      5.2内部接口设计

      5.3外部接口设计

6.出错处理设计

7.系统维护设计

          详细设计说明书又可称程序设计说明书。说明一个软件系统各个层次中的每一个程序的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书。

1.引言

      1.1编写目的

      1.2背景

      1.3参考资料

      1.4术语定义及说明

2.设计概述

      2.1任务和目标

      2.2需求概述

      2.3运行环境概述

      2.4条件与限制

      2.5详细设计方法和工具

3.系统详细需求分析

      3.1详细需求分析

      3.2详细系统运行环境及限制条件分析接口需求分析

4.总体方案确认

      4.1系统总体结构确认

      4.2系统详细界面划分

           4.2.1应用系统与支撑系统的详细界面划分

           4.2.2系统内部详细界面划分

5.系统详细设计

      5.1系统结构设计及子系统划分

      5.2系统功能模块详细设计

      5.3系统界面详细设计

           5.3.1外部界面设计

           5.3.2内部界面设计

           5.3.3用户界面设计

6.信息编码设计

      6.1代码结构设计

      6.2   代码编制

    据库设计说明书是对于设计中的数据库的所有标识．逻辑结构和物理结构做出具体的设计规定。

1.设计要求

2.信息模型设计

3.数据库设计

      3.1设计依据

      3.2数据库种类及特点

      3.3数据库逻辑结构

      3.4物理结构设计

      3.5数据库安全

      3.6数据字典

用户手册是详细描述教育软件的功能、性能和用户界面，使用户了解到如何使用该软件。

1.引言

      1.1编写目的

      1.2项目背景

      1.3定义

      1.4参考资料

2.软件概述

      2.1目标

      2.2功能

      2.3性能

3.运行环境

      3.1硬件

      3.2支持软件

4.使用说明

      4.1安装和初始化

      4.2输入

      4.3输出

      4.4出错和恢复

      4.5求助查询

5.运行说明

      5.1运行表

      5.2运行步骤

6.非常规过程

7.操作命令一览表

8.程序文件(或命令文件)和数据文件一览表

9.用户操作举例

充分叙述本软件所能实现的功能及其运行环境，以便使用者了解本软件的使用范围和使用方法。

1.引言

      1.1编写目的

      1.2参考资料

2.软件概述

      2.1本软件开发目的

      2.2基本原理

      2.3基本功能

      2.4软件运行

      2.5系统配置

3.软件使用

      3.1软件安装

      3.2运行表

      3.3运行步骤

      3.4运行说明

4. 操作说明

      4.1功能一

           4.1.1功能描述

           4.1.2用户界面

           4.1.3操作方法

      4.2功能二

           4.2.1功能描述

           4.2.2用户界面

           4.2.3操作方法

5.软件维护

      5.1程序设定

      5.2专用维护程序

1.引言

      1.1编写目的

      1.2项目背景

      1.3定义

      1.4参考资料

2.修改情况说明

3.模块开发情况表

4.功能说明

5.设计说明

6.源代码清单

7.测试说明

8.复审结论

在日常工作中经常会遇到对一个项目或一个任务制定一个工作计划，测试作为一个项目的一部分也要求有测试计划。测试活动作为一种有组织、有步骤的活动必然就需要计划进行安排。

1.标题

标题的格式为：XXXXX（项目名称）测试计划，如下图例子：

图 13 标题样式

2.版本号

版本号包括文档的创建时间、文档的编辑修改时间、文档的创建者、文档的编辑者、文档的修改版本记录。

图 14 版本号样式

3.目录

记录测试计划中各模块所在文档中的位置，目录需要自动生成，切忌使用人工手打的方式编写文档的目录信息。

图 15 目录样式

4.软件测试的目的和阅读人群

简单叙述文档的目的，文档的目的可以写针对某系统所做的软件测试计划，为了方便测试资源的调度、测试进度的控制、测试资源的分配。阅读人群可以定位为项目经理、测试经理、测试人员等。

图 16 目的及阅读人群样式

5.测试对象和产品概述

在这里需要写出这次计划需要测试一些什么功能和模块，然后接着编写产品的概述，就是测试的软件是一个什么类型的软件，要完成什么样的功能。

图 17 声明样式

6.测试时间的安排、测试人员的分工、测试过程中的准入准出标准

图 18 测试过程样式

7.如果测试中需要使用测试工具进行测试必须将工具和版本号以及工具运行的平台写清楚，如果涉及到兼容性测试，需要写明需要兼容哪些方面。

8.测试环境的说明

图 19 环境说明样式

9.风险控制

图 20 风险控制样式

1.引言

      1.1编写目的

      1.2背景

      1.3定义

      1.4参考资料

2.测试概要

3.测试结果及发现

      3.1测试1（标识符）

      3.2测试2（标识符）

4.对软件功能的结论

      4.1功能1（标识符）

           4.1.1能力

           4.1.2限制

      4.2功能2（标识符）

5.分析摘要

      5.1能力

      5.2缺陷和限制

      5.3建议

      5.4评价

6.测试资源消耗      

1.报告时间及所处的开发阶段

2.工程进度

      2.1本月内的主要活动

 2.2实际进展与计划比较

3.所用工时

4.所用机时

5.经费支出

6.工作遇到的问题及采取的对策

7.本月完成的成果

8.下月工作计划

9.特殊问题            

1.引言

      1.1编写目的

      1.2项目背景

      1.3定义

      1.4参考资料

列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。

2.开发结果

      2.1产品

      2.2主要功能及性能

      2.3所用工时

      2.4所用机时

      2.5进度

     2.6费用

3.评价

      3.1生产率评价

      3.2技术方案评价

      3.3产品质量评价

4.经验与教训

通过以上对十四个文档编写标准的学习，可以将以上文档分为三类,即开发文档、管理文档和产品文档。同时，编写文档时应遵循七大要点，即灵活性、重复性、完整性、及时性、精确性、针对性、可追溯性（见图22）。在编写每一个工程文档时，首先应该了解其目的，如教育项目开发计划对项目的开发做了详细的开发计划，对系统的开发具有引导作用，保证项目团队按时保质完成项目目标，便于项目团队成员更好地了解项目情况，使项目工作开展的各个过程合理有序，在该文档中，尤其要注意的是应当通过甘特图来时刻显示开发的进度。同时，需要特别注明的一点是要结构清晰明了，便于项目文档的修改和项目的实施。

图 21 工程文档的分类

 图 22 文档编写要点

1.计算机软件文档编制规范 http://wenku.baidu.com/link?url=ufWRkMTMbcqjJvTYVGF2I-zmC6ehcgsSD5bUaihhvByB3F0J6ClE2qdiQeDe5uKb7ic_ge9XlLA03HyCXGeHPVvV2gwZiszjGVUhwxzuGGG

[1]施庆平. 面向案例驱动的《软件文档写作》课程改革与实践[J]. 现代计算机(专业版), 2013, 31期:46-47.