软件开发文档编制规范（文档编写的基本要求）

本文目录

• 文档编写的基本要求
• gb856788计算机软件产品开发文件编制指南是什么标准
• 计算机软件产品开发文件编制指南颁布时间
• 软件开发需要编写哪些文档
• 软件开发项目中，过程管理文档包括哪些

文档编写的基本要求

1.范围
适合于Microsoft Word类文档，但编号规则适用于全部项目和模版文档。
2.文档首页(封面)
《页首》公司徽记
文档名称
文档编号
版本号
《页尾》 作者：
年 月 日
公司名称
命名规则：当前版本没有设置专门的规则，只是用中文命名，这个文件名表达了编写该文档的意图，后缀为相应文档软件的扩展名。
编号规则：Q/RKS -《ID》-《TYPE》-《SNO》
《Q/RKS》 公司代码
《 ID 》 英文缩写
1）SP 软件过程模板类
2）YYXXX 项目工作产品类
YYXXX表示项目代码，五位：YY：为年号 XXX：为序号
《TYPE》 文档类别，英文缩写。
例子： GNR 通用类文档
RM 需求类文档（包括验收计划）
SPP 项目计划类文档（包括各种测试计划）
SPT 计划跟踪和监控类文档
SQA 质量保证类文档
SCM 配置管理类文档
PR 评审类文档
COM 沟通类文档
DES 设计类文档
TRN 培训类文档
EST 项目估算类文档
TEC 技术标准类文档
DEV 开发规范类文档
MTN 维护类文档
DB 数据库DDL脚本类文档
QC 测试类文档
《SNO》 文件按时间产生的顺序号，范围01-99。
例子： Q/RKS-SP-GNR -09 -》 文档书写规范
版本编号：初始的版本号为1.0，为适应某一方面的要求进行的升级为点版本升级，如1.1、1.2等，全面的设计更改或大的变更，升级为2.0、3.0等。
说明：在项目中使用各种模版时，模版中出现的软件过程模版类编号一律改为项目工作产品类编号，如软件需求说明书页脚的Q/RKS-SP-RM-05改为Q/RKS-YYXXX-RM-SNO。
3.页眉与页脚
(1)、原则：页面属性配置为无网格。
(2)、页眉： 文档名称
自动加下划线
例子：
软件需求说明书 版本号：1.0
(3)、页脚：
文档ID
例子：
Q/RKS-SP-RM-05 2001年8月15号 Page 1 of 5
说明：在项目使用时，其中版本号为项目文档的版本号，日期为项目文档的编写时间。
4.文档控制和签字确认
有首页(封面)的放在第二页，即目录页前一页；无封面放在最后一节。
例子：
文档修订
版本 日期 修改人 描述（注明修改的条款或页）
批准人签字
职务 甲方/乙方 姓名 日期
5.目录
比较大的文档可设置目录页，配置为显示页码和页码右对齐，直接插入即可，单独成为一页。此页加正文“目录” 。显示级别为3，格式选模板中“正式”，字体四号。
6.正文（含附录）
字体：中文宋体小四，不加粗；
标题1：黑体，三号，加粗(Microsoft word2000缺省)；如:“1.”
标题2：黑体，四号，加粗(Microsoft word2000缺省); 如:“1.1”
标题3：黑体，小四号，加粗(Microsoft word2000缺省), 如:“1.1.1”
编号控制在4级之内。
行间距：单倍行间距。
段落出现两行以上的首行缩进二个汉字，段落间可加一空行。

gb856788计算机软件产品开发文件编制指南是什么标准

GB/T 8567-88 计算机软件产品开发文件编制指南。国家标准，推荐性，已废止，代替（现行）的标准是：GB/T 8567-2006 计算机软件文档编制规范。该标准根据GB/T 8566-2001《信息技术 软件生存周期过程》的规定，主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。该标准原则上适用于所有类型的软件产品的开发过程和管理过程。使用者可根据实际情况对标准进行适当剪裁（可剪裁所需的文档类型，也可对规范的内容作适当裁剪）。软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的内部文档（开发文档）两类。供方应提供的文档的类型和规模，由软件的需方和供方在合同中规定。

计算机软件产品开发文件编制指南颁布时间

《计算机软件产品开发文件编制指南》（GB/T 8567-1988）1988年7月1日实施的，这个已经不能用了，现在用的是2006版的《计算机软件文档编制规范》（GB/T 8567-2006 ）

软件开发需要编写哪些文档

这个问题没有一定的，因为这里有多种因素
如，开发阶段、文档化要求程度等，若是通过CMM评估的，文档就较多

一般的是按项目开发过程来分，基本的有
可行性研究报告（若是一个新项目且未确定的或应客户要求时需要，实际上大部份公司很少有这文档)
用户需求说明书(用户+开发人员共同确认)
软件需求规格说明书
设计说明书(体系结构、详细设计)
测试用例
用户手册
实现代码

这些文档中，包括一定的分析与设计图形，如用例图、数据库结构、ER图等
当然项目计划、测试计划也应算在内

其它的(如CMM要求的)
风险、估算方面的，质量保证方面的、配置管理方面、定义的模板、度量数据库等
具体需要多少文档就是要看项目实际

这方面的东西，可参考一些软件工程类的书

软件开发项目中，过程管理文档包括哪些

　　在软件项目开发过程中，应该按软件开发要求撰写十三类文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性！
　　需求阶段
　　1、可行性分析报告
　　说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
　　2、项目开发计划
　　为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
　　3、软件需求说明书（软件规格说明书）
　　对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
　　设计阶段
　　4、概要设计说明书
　　该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
　　5、详细设计说明书
　　着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
　　开发阶段
　　6、开发进度月报
　　该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
　　测试阶段
　　7、测试计划
　　为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
　　8、测试分析报告
　　测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。
　　收尾阶段
　　9、用户操作手册
　　本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
　　10、项目开发总结报告
　　软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。
　　11、软件维护手册
　　主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。
　　维护阶段
　　12、软件问题报告
　　指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软
　　件修改提供准备文档。
　　13、软件修改报告
　　软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。