文档介绍：软件文档编写规范
文件状态:
[√] 草稿
[ ] 正式发布
[ ] 正在修改
产品名称:
文件编码:
编撰:
李景荣
编撰日期:
2011年1月19日
保密级别:
文档版本:
通用供应链技术与系统
修订表
编号
生成版本
修订人
修订章节与内容
修订日期
1
李景荣
初稿
2011-01-19
2
3
4
审批记录
版本
审批人
审批意见
审批日期
目录
1 引言 1
2 引用标准 1
3 范围 1
4 文件的使用者 2
5 软件生存周期与各种文件的编制 3
6 文件编制中的注意事项 5
文件的读者 5
重复性 5
灵活性 5
应编制的文件种类 6
文件的详细程度 6
文件的扩展 6
图表索引
图 1 用户对文件的需求 8
图 2 软件生存周期 8
表 1 软件生存周期各阶段内编制的文档 9
1 引言
软件文档(document)也称文件,通常指的是一些记录的数据和数据媒体,它具有固定不变的形式,可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软件产品的效益有着重要意义。本文参照GB-T8567-2006《计算机软件文档编制规范》制定此软件开发文档编制规范,供通用供应链技术与系统公司(GSCT)软件研发使用。
2 引用标准
GB-T8567-2006《计算机软件文档编制规范》
GB/T11457-2006 《中华人民共和国国家标准:信息技术软件工程术语》
3 范围
一项软件的开发周期中,一般地说,应该产生十四种文件。这十四种文件是:
   可行性研究报告;
   项目开发计划;
   软件需求说明书;
   数据要求说明书;
   概要设计说明书;
   详细设计说明书;
   数据库设计说明书;
   用户手册;
   操作手册;
   模块开发卷宗;
   测试计划;
   测试分析报告;
  
开发进度月报;
   项目开发总结报告。
以上14种文件是针对一般性的软件开发所建议应该生成的文档,可以根据软件项目的规模适当的增加或者合并软件的文档。根据GSCT的特性,还有三种文档:
项目会议纪要:主要是项目组核心成员关于项目内容讨论的会议纪要。
软件功能修改申请:项目交付用户使用后,由于业务需求的变化需要修改软件内容时,业务相关人员必须提交修改申请,经相关的负责人员批准通过后,交予软件项目负责人。软件负责人接到软件修改申请后,评估修改的工作量和会对软件产生的影响,将申请转化为具体的修改需求。
软件功能修改报告:软件项目负责人通过对修改申请的评估,将申请转化为具体的修改需求,提交给开发人员对软件功能进行修改。
 4 文件的使用者
不同的使用人员,随他们所承担的工作的不同,对文档的需求也会有所不同。如图1所示。
可行性研究报告
项目开发计划
管理人员模块开发卷宗
开发进度月报
项目会议纪要
              项目开发总结报告
可行性研究报告,
项目会议纪要
              项目开发计划
              软件需求说明书
              数据要求说明书
           概要设计说明书
              开发人员详细设计说明书
              数据库设计说明书,
              测试计划,
              测试分析报告;
扩充修改申请
修改报告
用户
操作手册
用户手册
图 1 用户对文件的需求
以上文档是对软件开发过程中所产生文档的使用建议。用户应该得到的文件的种类由供应者与用户之间签订的合同规定。
5 软件生存周期与各种文件的编制
一项计算机软件,从出现一个构思之日起,经过这项软件开发成功投入使用,直到最后决定停止使用,并被另一项软件代替之时止,被认为是该软件的一个生存周期。一般地说这个软件生存周期可以分成以下六个阶段,如图2 所示:
图 2 软件生存周期
各个阶段的工作简介如下:
   可行性研究与计划阶段:确定该软件的开发目标和总的要求,进行可行性分析、投资--收益分析、制订开发计划,并完成应编制的文件。
需求分析阶段:由系统分析人员对被设计的系统进行系统分析,确定对该软件的各项功能、性能需求和设计约束,确定对文件编制的要求