014软件开发技术管理规范

侧石混凝挡墙分ISO9001质量体系作文件名编拟审批

称：号：制：核：准：

软件开发技文档管理规版号日日日生日：受状：会签部门

会签人/日期

发号：会签部门

会签人/日期脚容

侧石混凝挡墙分目录1.

前

目的1术语1参考文献1版本说明和改历史12.

软文

文档的定义作用1软件文档的类软件文档的作与软件存周期之的关系文档的使用33.

文编格规

文档编码规4文档组成格4封目版本更新说文件内正文格文档制作工74.

文管规

文档管理岗职责7文档的制作7文档的分类、编码与标文档的作者、修改者和打字文档的收集8文档的配置8文档的控制8文档的修改理文档的借阅复制管理度9文档的保密95.

技文的量价1脚容

侧石混凝挡墙分前言1.1目的软件开发的不同阶段都会产生大量的文档。为了加强管理、提高工作效率，充分借鉴前人的经验对文档进行规范化管理是很有必要的它对于保管在开发中形成的文档为公司积累宝贵的技术知识的财富为今后的软件开发工作提供第一手的宝贵资料起着重要的作用。为了规范创智集团工程项目的开发工作据国家标准局制定的有关软件开发和开发文件的规范标准，结合公司的实际，制定本规范。1.2术语略。1.3参考文献1)2)3)4)5)

《1998计算机软件工程规范----国家标准》中国标准出版社1998年6第一版。《软件工程概论》郑人杰等清华大学出版社19984月第一版。《实用软件工程》郑人杰等清华大学出版社19974月第二版。《创智软件园文档管理规范》创智（湖南）软件园有限公司19965。《创智软件园软件开发管理规范》创（湖南软件园有限公司1995年12。1.4版本说明和修历史本规范是在公司原有文档规范的基础上，于年月份修订而成，具体的修订人员为孙继纲、赵海等。软件文档2.1文档的定义及用文档（document）是指某种数据媒体和其中所记录的数据。它具有永久性，脚容

侧石混凝挡墙分并可以由人或机器阅读，通常仅用于描述人工可读的东西。正确地制作和使用软件文档，可以获得如下的便利：提高软件开发过程的能见度。提高开发效率。作为开发人员在一定阶段的工作成果和结束标志。记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。2.2软件文档的分对于软件文档的分类有多种方法。从形式上分为两类：开发过程中可以填写的各种图表，可称之为工作表格。应编制的技术资料或技术管理资料，可称之为文档或文件。按照软件文档的产生和使用范围可以分为三类：开发文档：软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括可行性研究、项目开发计划、需求说明、数据说明、概要设计和详细设计。管理文档：软件开发过程中，由软件开发人员制定的需提交管理人员的一些工作计划和工作报告，包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。用户文档：软件开发人员为用户准备的有关该软件使用、操作、维护的资料，包括用户手册、操作手册、维护修改建议、需求说明。按照计算机软件产品开发文件编制指南的国家标准（GB8567-88）的要求，在一项计算机软件的开发过程中，一般地说，应该产生种文件：可行性研究报告。项目开发计划。软件需求说明书。数据要求说明书。概要设计说明书。详细设计说明书。数据库设计说明书。用户手册。操作手册。模块开发卷宗。测试计划。测试分析报告。开发进度月报。项目开发总结报告。脚容

侧石混凝挡墙分2.3软件文档的制与软件生存周之间的关系一般而言，计算机软件生存周期可以分为六个阶段：可行性与计划研究阶段。需求分析阶段。设计阶段。实现阶段。测试阶段。运行与维护阶段。在软件开发的不同阶段产生的软件文档不同具体对应关系如下表所示。阶段可行性研究与计划需求分设计实现测试运行与维文档可行性研究报告项目开发计划软件需求说明书数据要求说明书测试计划概要设计说明书详细设计说明书数据库设计说明书模块开发卷宗用户手册操作手册测试分析报告开发进度月报项目开发总结2.4文档的使用者

阶段析阶段阶段阶段阶段护阶段对于软件文档的使用人员而言与其所承担的工作有关具体情况如下所示。管理人员：可行性研究报告。项目开发计划书。模块开发卷宗。开发进度月报。项目开发总结报告。开发人员：可行性研究报告。项目开发计划书。需求分析说明书。概要设计说明书脚容

维护人员：最终用户：

侧石混凝挡墙分详细设计说明书数据库设计说明书。测试计划。测试分析报告。设计说明书。测试分析报告。模块开发卷宗。系统安装手册。用户手册。系统维护手册。系统功能说明书文档编制格式规范3.1文档编码规则公司所有的技术文档，都必须具有一个唯一的系列号，格式为：PRS-PID-XX：1)“PRS创智标识符（CompanyFlag)。2)“PID项目代号。3)“XX档标识号，参见《软件开发配置管理规程例如，文件号：PRS-PowerOffice-MD-01-1.0.0表示：该文件由本公司产品PowerOffice，MD表示是管理文档，001表示是项目开发计划书，版本号1.0.0表示是PowerOffice品1.0.0版。3.2文档组成格式公司所有文档（仅一页的文件可按单页文档格式组织）由封面、目录ContentTable)、版本更新说明书（Rivision)、文件内容等组成，如图所示图文组档封面封面组成可划分为：1.文档号：DOC.NO.文档系列号(文档文名)字体:Arial,小四,加粗脚容

例侧石混凝挡墙分例：DOC.NO.PRS-PID-XX(Facedoc.doc)例2.项目名:中文字体黑体,三号字体,加粗英文字体:Arial,三号字体,加粗创智文档范3.文档名:

中文字体：黑体一号字体,加粗英文字体：Arial,一号字体,加粗工程技术目文档规范例：4.密级英文字体:Arial,小四字体,加粗划分为五类，采用下列关键词TopConfidentialHighConfidentialConfidentialNormalGeneralTopConfidential绝密产品文档HighConfidential机密规范、指南Confidential秘密计划、管理Normal普通工作岗位有关General明文可以在社会上广为流传例:Normal5.版本号：关键词为Version用字体,大小为小四号例:VersionV1.0.06.完成日：用Arial字体大小为小四号例:1994.11.14.7.作者WrittenBy……用Arial字体,大小为小四号,加粗例:WrittenPOWERISE8.公司LOGO:用USABLack字体,大小为四号加粗。例:POWERISE9.公司名及版权效年份关键词为：创智软件园有限公司PoweriseSoftware.Inc.版权生效年限：关键词为（C）公历年号中文字体:黑体,四号,加粗例:创智软件园有限公司(C)1994,1999注：此填写产品已经过的份，如PowerLCMS,copyrights(C)1996,1998.英文字体:Arial,四号,加粗脚容

侧石混凝挡墙分例:PoweriseSoftware.Inc.(C)1994,199510.版权申：字体为Arial,小四,加粗例:AllRightReserved各项安排如下图,样板范例可参见本文档的封面：目录可采用手工编制或使用文档编制MicrosoftWord的自动生成目录的功能产生文档目录。版本更说明关键词为Revision容划分为期(Date)由Reason)新者(Revisor)。(首版可省略该节)文件内文件内容每一页必须包含下列三项，缺一不可：页首，在页首中部自动填入‘标题’的名称。页脚，在页脚左部填入创智标徽POWERISE，右部填入页号。正文。如下图所示，具体设置可复制本文作模块。标题Powerise创智（创智标image）X正文格标题一：宋体、小三、粗体，左对齐；标题二：黑体、四号、粗体，左对齐；标题三：宋体、小四号、粗体，左对齐；标题四：黑体、小四号、正常体，左对齐；标题五：黑体、五号、粗体，左对齐；脚容

侧石混凝挡墙分正文：宋体、小四号、正常体，左对齐。以上行距为单倍行距。3.3文档制作工具使用何种文档制作工具原则上没有限制但必需考虑到文档交流的方便性问题因此如果在文档的交流方面因为文档制作工具的使用差异造成工作上的不便，文档制作者本人应该设法解决。用于交流和上交的文档登记说明上，应注明所使用的文档制作工具。文档管理规范4.1文档管理岗位责产生文档的单位包括：开发部的项目组和配置测试中心的配置测试组。项目组的职责：编写开发计划书，评/审查通过后，向配置测试组提交，进入配置管理。编写阶段开发计划书、技术文档，经过评/审查后，向配置测试组提交，进入配置管理。编写阶段总结报告，向配置测试组提交，进入配置管理。配置测试组的职责：编写配置测试评审计划书，评审/审查通过后，进入配置管理。编写阶段计划书、配置、测试和评审文档，经过评/审查后，进入配置管理。收集项目组的管理文档和技术文档执行阶段计划书、配置、测试和评审，经过评/审查后，进入配置管理。

编写阶段总结报告，进入配置管理。4.2文档的制作任何软件开发技术文档的作者必须严格按《软件开发技术文档管理规范》来制作。技术文档的制作可以由作者本人完成，这就要求各开发人员学习文档的制作规范，按规范进行文档编写。技术文档也可以由作者本人手工书写，交秘书来打字完成，但技术文档的作者必须进行校对工作。脚容

侧石混凝挡墙分文档的类、编码与识参见《软件开发配置管理规程》文档的者、修改者打字者对此管理的目的是明确文档的来源，使整个开发的流程清晰可查。以便今后可就某个技术细节找到相应的（作者进行更进一步的探讨和学习也便于对某个项目的工作任务作出合理的安排。每本文档在形成时，在封面就须写清楚文档的第一作者及其合作者。如果文档进行了修改、改版，在版本更新说明中，还必须写清修改人。在对文档进行登记归档时也必须如实记录作者。其中有第一作者，修改者。同时记录打印人和定稿打印的日期。4.3文档的收集技术文档的收集包括2种方式是作者将完成的合乎规范的技术文档主动交配置测试中心关于本项目指定的配置测试工程师进行配置管理种是配置测试中心关于本项目的配置测试工程师，根据项目阶段任务和阶段成果的安排，在适当的时候向相关的文档制作者收集技术文档，进行配置管理和版本控制。4.4文档的配置与项目有关的管理文档和技术文档的管理最终统一归口于软件配置测试中心的配置管理组技术文档的管理方式是按部门部门下面的项目组项目组的不同阶段加以配置管理和版本控制例如：以上只是管理的一种形式，它是根据部门来分类。另外还可以根据其它特征来分类。这些特征有时间、作者、部门、项目、文档类别等。具体采用什么样的特征可根据具体情况进行适当的分类。在对文档进行管理时必须对每一份正式的文档进行详细的登记登记时的原则是：手续严密、格式清晰醒目、简化适用、登记项目完整详尽。这样在对文档进行管理时便于查找文档和检查文档的运转情况一般采用簿式登记以便清晰可查。4.5文档的控制为保持文档和程序产品的一致性持各种文件之间的一致性和文件的安全性，需要对文档进行控制，具体表现在：应该有文档管理员集中保管本项目现有全部文档的主文本两套，由其负责保管脚容

侧石混凝挡墙分每一份提交给文档管理人员的文档必需具有编写人、审核人和批准人的签字两套文本的内容一致，其中一套可以出借，另一套绝对不可以出借文档的借阅和归还必需有出借和注销的手续项目组种的个人文档必需和整个项目的主文档的内容和版本一致一份文档如果被新文档更新，原文件必需注销4.6文档的修改管在项目开发过程中，项目组内部的任何人都可以提议对开发工作的文件成果进行修改，但必需遵循如下的步骤：提议：项目组内部任何一个人都可以填写修改建议表，提出对文档的修改建议评议：由项目负责人或项目负责人制定指定的人员对文档修改提议进行评议，包括审查该项修改的必要性、影响范围、研究进行修改的方法、步骤和实施计划审核：由项目负责人进行审核，包括合适修改的目的和要求、核实修改活动将带来的影响、审核修改活动计划是否可行批准：由开发单位的部门负责人进行批准，主要是决断修改工作中各项活动的先后顺序及各自完成日期，以保证整个开发工作按园丁计划日期完成实施：由项目负责人按已批准的修改活动计划，安排各项修改活动的负责人进行修改，建立修改记录、产生新的文件以取代原有文档，最后把文档交付文档管理员，并奋发给有关的持有者4.7文档的借阅和制管理制度技术文档的借阅包括3种情况。一种是在软件开发部门内部的技术文档借阅一种是项目组内部的文档借阅一种是已经配置管理于配置测试中心的技术文档的借阅。对于部门内部的技术文档借阅，申请人必须拥有部门经理的签名许可。对于项目组内部的技术文档借阅