HLJJFT 102-2017 软件工程文档编制规范黑龙江省交通运输信息化建设项目.docxVIP

HLJJT

黑龙江省交通运输信息化建设项目标准规范HLJJT102-2017

软件工程文档编制规范

2017-03-06发布2017-03-16实施

黑龙江省交通运输厅发布

I

软件工程文档编制规范

目次

1引言 1

2规范性引用文件 1

3软件工程文档构成 1

4软件工程文档编制 3

4.1文档编制说明 3

4.2文档编制的考虑因素 8

4.3文档递交格式要求 9

5附件目录 9

软件工程文档编制规范

1

软件工程文档编制规范

1引言

为规范黑龙江省交通运输信息化建设项目软件工程的文档编制，制定《黑龙江省交通运输信息化建设项目软件工程文档编制规范》,以下简称本规范。

本规范根据GB/T8566—2007《信息技术软件生存周期过程》及《黑龙江省交通运输信息化建设管理暂行办法》的规定，主要对软件工程的开发过程和管理过程应编制的基本文档及其编制的内容、格式等基本要求做出规定。

本规范原则上适用于黑龙江省交通运输信息化建设项目所有类型的软件开发过程和管理过程。

2规范性引用文件

下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范，凡是不注日期的引用文件，其最新版本适用于本规范。

GB/T8566—2007信息技术软件生存周期过程

《黑龙江省交通运输信息化建设管理暂行办法》

3软件工程文档构成

黑龙江省交通运输信息化建设项目软件工程主要分为项目前期阶段、开工许可阶段、项目招投标阶段、项目实施阶段、试运行阶段、初步验收阶段、缺陷责任期阶段、竣工验收阶段八个阶段。

软件工程每个阶段应产生的文档如下表所示：

表1各阶段文档列表

序号

工程阶段

产出文档

一

项目前期阶段

a、项目建议书

b、可行性研究报告

c、初步设计方案

2

软件工程文档编制规范HLJT

软件工程文档编制规范

HLJT

二

开工许可阶段

a、施工组织计划

b、招标方案

c、项目开工通知书

三

项目招投标阶段

a、招标文件

b、投标文件

c、评标报告

d、中标通知书

e、合同

四

项目实施阶段

a、需求规格说明书

b、概要设计说明书

c、详细设计说明书

d、数据库设计说明书

e、实施方案

f、项目实施计划

g、工程进度报告

h、支付申请书

i、硬件到货验收报告

j、系统集成方案

k、集成完成报告

1、安装验收确认书

m、源代码清单

n、测试方案

o、试点推广完成报告

p、第三方测试报告

q、安全等级保护测评报告

r、用户操作手册

s、管理员手册、

五

试运行阶段

a、系统培训方案

3

HLJT软件工程文档编制规范

HLJT

b、试运行方案

c、系统上线报告

d、试运行完成报告

六

初步验收阶段

a、用户确认测试报告

b、初步验收方案

c、初步验收申请报告

d、总集技术验收报告

e、初步验收报告

七

缺陷责任期阶段

a、缺陷情况报告

八

竣工验收阶段

a、竣工验收方案

b、竣工验收申请报告

c、竣工验收报告

鉴于软件工程项目所涉及文档的多样性，本规范仅作为软件工程基本文档的编制指南，也是这类文档编写质量的检验准则。

本规范规定了在软件工程过程中文档编制的基本要求，这些文档从使用的角度可分为用户文档和开发文档两大类。文档的管理要求详见《黑龙江省交通运输信息化建设管理暂行办法》的相关条款。

4软件工程文档编制

4.1文档编制说明

如前所述，黑龙江省交通运输信息化建设项目软件工程分为八个阶段，每个阶段均会产生基本文档，针对这些文档的编制将做如下说明。

4.1.1前期工作阶段

a)项目建议书

项目建议书(模板见附件一)的编制是项目立项前的一项基础工作，是编制项目可行性研究报告的基础和依据。

b)可行性研究报告

可行性研究报告(模板见附件二)是项目立项的依据，项目建议书审查合格后，即可编制项目可行性研究报告。

4

软件工程文档编制规范

c)初步设计方案

初步设计方案(模板见附件三)的编制是项目立项后的一项基础工作，是根据审定通过的可行性研究报告和批复的意见编制完成的，是项目招标的依据，项目实施的基础。

4.1.2开工许可阶段

a)施工组织计划

施工组织计划(模板见附件四)是对项目施工过程中各项活动进行指导的综合性文件，主要包括项目建设内容，批复意见、资金预算和使用、职责分工、进度安排等内容，是施工技术与施工项目管理有机结合的产物，能够保证工程开工后施工活动有序、高效、科学地进行。

b)招标方案

招标方案(模板见附件五)是针对项目招标的总体策划，