文档分类
文档分类
项目包括如下几类文档；
项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》
软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》。
软件测试文档。包括：《测试计划》、《软件测试分析报告》。
产品资料。包括：《用户操作手册》。
本项目文档的版本号由以圆点隔开的两个数字组成，第一个数字表示出版号，第二个数字表示该版的修订号。具体用法如下：
当文档初版时，版本号为
V1.0
；
当文档被局部修订时，出版号不变，修订号增
1
。例如，对初版文档作了第一次修订，则版本号为
V1.1
；
当文档被全面改写或局部修订累积较多导致文档发生全局变化时，出版号增
1
。例如，在
V1.5
版的基础上作了一次全面修订，则新版本号为
V2.0
。
项目所产生的文档都有唯一、特定的编码，其构成如下：
项目标志
-
任务标识
-
文档类型
-
文档树中的编号
-
版本号
/
序号
其中：
项目标志：本项目的标识，表明本项目是“
XXXX
”。
任务标识：少于八个字母，简要标识本任务，标准
XXXX
是“
STANDARD
”。适用于整个项目的文档，此标识为“
XXXX
”。
文档类型：取自下表的两位字母编码。
编号：反映文档类型（根据下表填写）
版本号：本文档的版本号。
序号：四位数字编码，指明该文档在项目文档库的总序号。
一个文档编码的例子为：
XXXX-XXXX-SP-2N01-V1.0/0015
|
文
档
类
型
|
编码
|
编号
|
注
释
|
|
|
项目管理
|
项目开发计划
|
PP
|
1002
|
Project Plan
|
|
项目进度报告
|
PR
|
1003
|
Project Report
|
|
|
软件开发
|
软件项目计划
|
SP
|
2N01
|
Software Plan
|
|
软件需求规格说明
|
SA
|
2N02
|
Software Anlaysis
|
|
|
软件设计说明
|
SD
|
2N03
|
Software Design
|
|
|
软件测试
|
软件测试计划
|
TP
|
4N01
|
Testing Plan
|
|
软件测试分析报告
|
TR
|
4N02
|
Tesing Report
|
|
|
产品文档
|
用户手册
|
RU
|
5N01
|
User guide
|
本项目中所有文档的标识清单将在《项目开发计划》中予以具体定义。
本项目中所有任务的文档将按照统一的模板（格式和内容的约定）来编写，包括：
《模板
-
软件开发计划》
《模板
-
软件需求规格说明》
《模板
-
软件设计说明》
《模板
-
技术说明》
文档的模板均保存在配置管理员处，并由其分发给文档的编写者。
需要说明的是，文档模板是本项目在文档结构和版式上的统一约定，对于具体文档，编写者可以根据需要添加章节，原则上不要删除章节（可以写“本章
/
节无内容”）。当文档模板不符合编写者要求时，编写者应与项目组长联系以决定文档的编写标准。
在
产品包中，应包含一份《技术说明》，以详细说明本产品的代码来源和修改情况。
在《技术说明》中，应包含如下内容：
代码包的清单，格式为：
|
代码包名
|
来源
|
版本
|
功能的描述
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
其中，“来源”可以是：下载的网络地址、“拷贝”、“创建”
代码文件的清单，格式为：
|
代码包名
|
文件名
|
状态
|
修改者
/
作者
|
最后修改时间
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
其中，“状态”可以是：“修改”、“删除”、“创建”、“原样”
封面格式：
文档编号
版
本
号
文档名称：
项目名称：
项目负责人：
编写
年
月
日
校对
年
月
日
审核
年
月
日
批准
年
月
日
开发单位
系统规格说明书（
System Specification
）
一．引言
A.
文档的范围和目的
B.
概述
1
．目标
二．功能和数据描述
A.
系统结构
1
．结构关系图
2
．结构关系图描述
三．子系统描述
A.
子系统的结构图规格说明
B.
结构字典
C.
结构连接图和说明
四．系统建模和模拟结构
A.
用于模拟的系统模型
B.
模拟结果
C.
特殊性能
五．软件项目问题
A.
软件项目计划
六．附录
软件项目计划（
Software Project Plan
）
一．引言
1
．编写目的（阐明编写软件计划的目的，指出读者对象。）
2
．项目背景（可包括：（
1
）项目委托单位、开发单位和主管部门；（
2
）该软件系统与其他系统的关系。）
3
．定义（列出本文档中用到的专门术语的定义和缩略词的原文。）
4
．参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）
二．项目概述
1.
工作内容（简要说明项目的各项主要工作
,
介绍所开发软件的功能
性能等
.
若不编写可行性研究报告
,
则应在本节给出较详细的介绍。
)
2.
条件与限制（阐明为完成项目应具备的条件
开发单位已具备的条件以及尚需创造的条件
.
必要时还应说明用户及分合同承包者承担的工作
完成期限及其它条件与限制。）
3.
产品
（
1
）程序（列出应交付的程序名称
使用的语言及存储形式。）
（
2
）文档（列出应交付的文档。）
（
3
）运行环境（应包括硬件环境
软件环境。）
4
．服务（阐明开发单位可向用户提供的服务
.
如人员培训
安装
保修
维护和其他运行支持。）
5
．验收标准
三．实施计划
1
．任务分解（任务的划分及各项任务的负责人。）
2
．进度（按阶段完成的项目
,
用图表说明开始时间
完成时间。）
3
．预算
4
．关键问题（说明可能影响项目的关键问题
,
如设备条件
技术难点或其他风险因素
,
并说明对策。）
四．人员组织及分工
五．交付期限
六．专题计划要点（如测试计划等。）
需求规格说明书（
Requirements Specification
）
一．引言
1
．
编写目的（阐明编写需求说明书的目的
,
指明读者对象。）
2
．
项目背景（可包括：（
1
）项目的委托单位
,
开发单位和主管部门；（
2
）该软件系统与其他系统的关系。）
3
．
定义（列出文档中用到的专门术语定义和缩写词的原文。）
4
．
参考资料（可包括：（
1
）项目开发计划；（
2
）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）
二．任务概述
1
．目标
2
．运行环境
3
．条件与限制
三．数据描述
1
．
静态数据
2
．
动态数据（包括输入数据和输出数据。）
3
．
数据库描述（给出使用数据库的名称和类型。）
4
．
数据词典
5
．
数据采集
四．功能需求
1
．功能划分
2
．功能描述
五．性能需求
1
．数据精确度
2
．时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）
3
．适应性（在操作方式
运行环境
与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。）
六．运行需求
1
．用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）
2
．硬件接口
3
．软件接口
4
．故障处理
七．其他需求（如可使用性、安全保密、可维护性、可移植性等。）
概要设计说明书（
Architectural Design Specification
）
一．引言
1
．编写目的（阐明编写概要设计说明书的目的，指明读者对象。）
2
．项目背景（可包括：（
1
）项目的委托单位
,
开发单位和主管部门；（
2
）该软件系统与其他系统的关系。）
3
．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4
．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（
1
）项目开发计划；（
2
）需求规格说明书；（
3
）测试计划（初稿）；（
4
）用户操作手册（初稿）；（
5
）文档所引用的资料、采用的标准或规范。）
二．任务概述
1
．目标
2
．运行环境
3
．需求概述
4
．条件与限制
三．总体设计
1
．处理流程
2
．总体结构和模块外部设计
3
．功能分配（表明各项功能与程序结构的关系。）
四．接口设计
1
．外部接口（包括用户界面
软件接口与硬件接口。）
2
．内部接口（模块之间的接口。）
五．数据结构设计
1
．
逻辑结构设计
2
．
物理结构设计
3
．
数据结构与程序的关系
六．运行设计
1
．运行模块的组合
2
．运行控制
3
．运行时间
七．出错处理设计
1
．出错输出信息
2
．出错处理对策（如设置后备、性能降级、恢复及再启动等。）
八．安全保密设计
九．维护设计（说明为方便维护工作的设施
,
如维护模块等。）
详细设计说明书（
Procedural Design Specification
）
一．引言
1
．
编写目的（阐明编写详细设计说明书的目的
,
指明读者对象。）
2
．
项目背景（应包括项目的来源和主管部门等。）
3
．
定义（列出文档中用到的专门术语定义和缩写词的原意。）
4
．
参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（
1
）项目开发计划；（
2
）需求规格说明书；（
3
）概要设计说明书；（
4
）测试计划
(
初稿
)
；（
5
）用户操作手册
(
初稿
)
；（
5
）文
分享到：
评论