IT技术研发文档模板(2个doc)1

IT技术研发文档模板(2个doc)1

部门： xxx

时间： xxx

整理范文，仅供参考，可下载自行编辑

第一部分前言

在第一次研发中心内部（技术二部）的广泛讨论与征求意见的基础上，经过总结，形成“技术文档规范EY2003-11-V0.20”。改动部分大体有以下几个方面：

（1）“配置编号”编制规则；

（2）“需求分析说明书/报告”，模板部分

（3）在需求部分以附件的形式增加“最新需求确定”模板，由技术研发中心苏正华负责起草

（4）统一文档原创者身份为“作者”

（5）文档模板中统一一项内容“产品名称”

（6）“需求/功能变更说明书”模板中增加“负责人签字”项

（7）“数据库设计报告（S）”模板增加“主键”项，“关联关系描述”项，存储过程项，触发器项

（8）产品测试报告（SP1）与（SP2）合并为一套模板，并在测试项遗留问题项中有多处变动，新增新问题项

（9）以附件形式增加“测试方案”模板，由由技术研发中心苏正华负责起草

（10）在 V0.10 的“第三部分内容”第一项“版本控制规则”中版本号增为4位数字

（11）在 V0.10 的“第三部分内容”第七项“详细设计”中有关代码文件的说明部分增加注释改动内容项

在本版中，将不再有V0.10中解释与说明的部分，缺少的必要部分将补充到本版中。

第一部分变动内容说明

一﹑版本控制规则

（1）版本状态：Alfa ，Beta，Deta/内部测试版，Release/对外正式发布版，Changing/内部变更状态

（2）版本号：版本号以四位数字表示，格式为i.jk.l（i=0，1，2，...，n；jkl=001， (999)

a.Alfa版，i=0

b.第一次正式发布的Release版，1.00

c.用Changing来表示内部测试版或Release版本的内部修改或升级状态

d.小的改动或升级i，jk保持不变，只增加l值即可，l的升值幅度为修改或升级处的数目，当l值达到或增加至9时，

l=l+1，l=0

e.比较大的改动如，一次修改或升级处的数目>10，功能性的增加或改变，则i.j保持不变，增加k值。如果是功能性的修改

或变动，每有一项k+1；如果是>10的非功能性的修改，每9处修改，k+1，个数部分用l来表示

f.重大变动，j值增加

g.在Alfa版状态下，如果变动累计超出999次，则Alfa版升级到Beta版，依次类推

二﹑配置编号编制规则及说明

（1）编制规则：

格式：EPD + 年份 + -所在年份项目号 + “-“ + 模板序号 + “-“ + H/S + “-“ + 模板编号 + “-” +附件标示A +”-“+ 附件编号

举例：EPD2003No5-05-S-01-A-01，表示2003年第5号项目的第5份模板，是软件部分的模板，当前模板为为第5份模板的第1部分（2）说明：

a.文档配置编号由专业技术秘书或技术文档管理员统一分配制定。

b.H，表示硬件；S，表示软件

c.A，表示附件；如果有多个附件，则从01开始依次编制。如果没有附件，省略

三﹑需求分析说明书/报告

需求分析说明书/报告

四﹑需求/功能变更说明书

需求/功能变更说明书

最新需求确定模板，附件

五﹑数据库设计报告（S）

数据库设计报告（S）

六﹑功能定义说明书

功能定义说明书

七﹑功能定义变更说明书

功能变更说明书

最新功能定义说明书模板，附件

八﹑概要设计

概要设计报告（S）

九﹑产品测试报告

产品测试报告（ST1）

测试反馈报告

产品测试反馈报告（ST2）

十﹑有关代码文件的说明部分增加注释改动内容项

（1）所有的代码模块必须用文件的方式组织

（2）在每一个文件中的开头以注释的方式写如下内容：

Copyright（c）2003，**公司，硬件开发部

*All rights reserved

*文件名称：

*文件标识：文件标识可以统一规定，也可以自己选择

*摘要：简要描述该文件的内容

*

*当前版本：

*作者：输入作者或修改者的名字