文档介绍：文档下载站源下载
软件文档编写向导
文档分类
项目包括如下几类文档;
项目管理文档。包括:《软件项目计划》、《项目进度报告》、《项目开发总结报告》
软件开发文档。包括:《需求规格说明》、《概要设计说明》、《详细设计说明》。
软件测试文档。包括:《测试计划》、《软件测试分析报告》。
产品资料。包括:《用户操作手册》。
文档的版本号
本项目文档的版本号由以圆点隔开的两个数字组成,第一个数字表示出版号,第二个数字表示该版的修订号。具体用法如下:
当文档初版时,版本号为 ;
当文档被局部修订时,出版号不变,修订号增1。例如,对初版文档作了第一次修订,则版本号为 ;
当文档被全面改写或局部修订累积较多导致文档发生全局变化时,出版号增1。例如,在 版的基础上作了一次全面修订,则新版本号为 。
文档的标识
项目所产生的文档都有唯一、特定的编码,其构成如下:
项目标志-任务标识-文档类型-文档树中的编号-版本号/序号
其中:
项目标志:本项目的标识,表明本项目是“XXXX”。
任务标识:少于八个字母,简要标识本任务,标准XXXX是“STANDARD”。适用于整个项目的文档,此标识为“XXXX”。
文档类型:取自下表的两位字母编码。
编号:反映文档类型(根据下表填写)
版本号:本文档的版本号。
序号:四位数字编码,指明该文档在项目文档库的总序号。
一个文档编码的例子为:
XXXX-XXXX-SP-2N01-
项目的文档分类表
文档类型
编码
编号
注释
项目管理
项目开发计划
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. 软件项目计划
附录
软件项目计划(Software Project Plan)
引言
编写目的(阐明编写软件计划的目的,指出读者对象。)
项目背景(可包括:(1)项目委托单位、开发单位和主管部门;(2)该软件系统与其他系统的关系。)
定义(列出本文档中用到的专门术语的定义和缩略词的原文。)
参考资料(可包括:文档所引用的资料、规范等;列出资料的作者、标题、编号、发表日期、出版单位或资料来源。)
工作内容(简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本