WISW701-3（1.2CLN）软件工作文档.doc

质量管理体系文件-WISW701-3

版本号：1.2

生效日期：2009.12.01

PAGE1

第PAGE4页共4页

软件工作文档编写须知

InstructionforPreparationofsoftwareWorkingDocuments

目录

修改版本

目的

适用范围

参照文件

定义和缩写

可行性分析报告的编写

需求说明书的编写

软件开发计划的编写

系统设计说明书的编写

开发进度与阶段测试计划表的编写

项目测试方案的编写

附录

版本号

修改页次

修改原因

1.0

1.1

1.2

全部

RWISW701-3/C2/2

RWISW701-3/A、RWISW701-3/B1/2，

RWISW701-3/C1/2，2/2；RWISW701-3/D1/2,RWISW701-3/F

根据QSCS2000，做进一步完善

根据工作需要做进一步完善

根据QMSR7.0（4.2.3）应用指南要求进一步完善

编写

审核

会签

批准

批准日期

陈新

王立真

王晨

朱恺

2009.11.25

目的

软件文档是有效控制软件管理工作各环节的一个重要保障，本指南旨在指导我社软件管理工作各阶段中所涉及的各类文档的编写，明确文档编制的基本内容，并使之规范化。

适用范围

本指南作为《软件管理工作程序》（WPSW701）、《软件开发工作指南》（WISW701-1）的补充文件，适用于本社软件管理、软件开发工作中有关文档的编制。

本指南中只给出了几个基本文件的编制要求和格式，所列文件内容为基本要求，实际工作中还可根据需要编制更为详细和具体的软件文档，以保证我社软件管理、软件开发工作的规范化和标准化运作。

为了使用和阅读方便，本指南中所有文件的编制均以表格形式给出，其中黑体字部分为文件编写要素，斜体字部分为相应的填写说明；表格形式非强制性要求，实际使用中可以根据具体情况调整表格形式、大小、宽度等，或以报告的形式给出。

在实际使用中，所有文件需要设置页眉和页脚，其中

页眉：（文档标题和体系文件编号）项目标识：（软件需求申请单编号）；

页脚：页号/页数

参照文件

软件管理工作程序(WPSW701)。

计算机软件开发规范(GB8566—95)。

计算机软件产品文件编制指南(GB8567—88)。

软件开发工作指南（WISW701-1）

定义和缩写

开发文档

是指在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。

这类文档包括软件需求说明书、系统设计说明书（数据库设计说明书、概要设计说明书、详细设计说明书）、可行性研究报告、软件开发计划等。

管理文档

是指在软件开发过程中，由软件开发人员制定的需提交给管理人员的一些工作计划或工作报告。使后者能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。

这类文档包括软件开发计划、测试计划、测试报告、软件开发总结等。

用户文档

是指软件开发人员为用户准备的有关该软件使用、操作、维护的资料等。

这类文档包括用户手册或操作手册、维护修改建议等。

可行性分析报告的编写

可行性分析报告文件模版参见附录1（RWISW701-3/A）

实际使用时可以不拘泥于表格形式。

需求说明书的编写

需求说明书文件模版参见附录2（RWISW701-3/B）

实际使用时可以不拘泥于表格形式。

软件开发计划的编写

《软件开发计划》文件模版参见附录3（RWISW701-3/C）

《软件开发计划》发放范围：一般应发至开发组每个成员、软件需求方代表、软件开发责任场所和软件管理场所。

系统设计说明书的编写

《系统设计说明书》文件模版参见附录4（RWISW701-3/D）。

可根据项目规模的大小决定是否需要做概要设计；大型项目（工作量在6人年或以上）应该做概要设计。

概要设计时可省略系统详细设计部分的内容。

详细设计的目标是编制出可供程序员直接编程所使用的详细的、规范化的功能设计说明。

开发进度与阶段测试计划表的编写

《开发进度与阶段测试计划表》文件模版参见附录5（FORMRWISW701-3/E）

开发阶段从大范围上说可以包括：需求调查及其需求分析阶段、需求分析评审、系统总体设计阶段、数据库设计阶段、详细设计阶段、设计评审、系统编码阶段、若干阶段测试期、系统集成测试阶段、文档整理和补充阶段、系统评审及使用培训阶段、系统试运行阶段等；在本计划中应根据以上这些阶段加以细化，使之成为可以有效进行跟踪与监控的计划。

项目测试方案的编写

《项目测试方案》文件模版参见附录7（FORMRWISW701-3/G）

根据测试计划，对每个测试阶段逐一制定项目测试方案，同一个测试方案中可以有若干个模块的测试方案。

附录

附录1可行性分析