您的当前位置:首页正文

IT技术研发文档模板

2024-07-16 来源:步旅网

第一部分  总纲

 

一﹑目    的:

  1. 规范公司内部技术研发工作的文档管理;
  2. 保持技术研发工作的完整性与连续性;
  3. 防止技术流失,减少风险;
  4. 使技术文档成为技术研发工作中的重要组成部分。

 

二﹑适用范围:本公司内部一切与技术研发有关的部门及个人,包括

  1. 总经理;
  2. 技术部门经理或负责人;
  3. 研发工程师;
  4. 测试工程师;
  5. 技术支持工程师。

 

三﹑目    标:

通过切实可行的文档管理规范,使得研发工作透明,明确,有章可循,合作无障碍,衔接环节畅通;使得所有的研发产品从开始研发——研发进程——测试——修改——阶段性结束——产品转化——升级维护过程中的所有环节都得以在相应的文档中体现。

 

四﹑版    本:E2003V0.10(简称V0.10)。

 

五﹑制定原则:

  1. 实用:鉴于公司目前的状况,通用性的开发模板(如国标)在很大程度上对于本公司并不实用,所以本规范将不会完全照搬此类模板,而是根据公司的具体情况制定公司内部的标准;
  2. 可行:可行性是该标准的起码要求,没有可行性的标准不能成为真正的标准
  3. 高效:如果将国标中的所有规范内容都纳入本标准,一定可以达到目的,实现目标。但是,同时必将为相关人员增添大量的工作量,而且很多工作对于本公司来说是冗余,从而造成相关人员的抵触情绪,使标准难于贯彻。所以,本标准应力求在尽量少的模板中体现尽量多的内容;
  4. 科学:本标准的制定虽然不完全照搬其他通用性的标准,但将大量参照通用标准,特别是国标中的某些部分内容,不是抛弃国标,而是以国标为原则,以保证科学性;
  5. 建立在广泛意见基础上:本标准并非公司某一个人单方面的意愿,而是从公司利益出发,全体相关人员共同参与,集体的结晶。

 

六﹑实行过程及生效日期:

  1. V0.10版的规范为规范草稿,草稿制订完成后,将在相关部门和相关人员中进行传阅和广泛征求意见。经过三次全体相关人员参与讨论和修改,由总经理审批签字后的规范版本为0.40
  2. V0.40为试用版本,在V0.40的试用过程中,将要求并给予相关人员以合理的时间尽量按照V0.40版的要求规范修改,补充和完善V0.40版以前(包括V0.10以前欠缺的文档)的有价值文档。在此期间,如有新的研发工作开始启动,将要求相关人员按照V0.40版的规范要求进行文档的相关操作。在此过程中,如果发现规范中需要修改和补充之处,每经过一次大幅度的修改,版本即升级到V0.5ii=1,2,3,…n,),每经过一次小的修改或补充,版本将升级为V0.4jj=1,2,3,…,n)。
  3. V1.00为正式版本。此时的版本已经经过讨论,试用,修改,补充和不断完善,并且V1.00以前欠缺的文档与V0.40试用过程中的文档都已经按照V0.40版本的要求整理完毕,此时的V0.40版已经成熟,可以整体升级到V1.00版。V1.00版本的文档规范将作为公司内部与技术研发工作相关的所有人员在今后相当一段时间内共同遵守的规范,并且将文档的撰写工作作为技术研发的一个重要组成部分正式纳入到技术研发工作中。
  4. V1.00规范将具有强制性和高约束力。

 

(注:Vi.00i=0,1,2,…表示i版本系列;Vi.mnimn=012表示i版本系列下的改动或升级)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

第二部分  目录索引

一﹑版本控制规则

二﹑立项

1﹑说明

2﹑模板

三﹑需求分析

1﹑说明

2﹑模板

四﹑可行性分析

1﹑说明

2﹑模板

五﹑功能定义

1﹑说明

2. 模板

六﹑概要设计

1﹑硬件部分

  1. 说明
  2. 模板

2﹑软件部分

  1. 说明
  2. 模板

七﹑详细设计

1﹑硬件部分

  1. 说明
  2. 模板

2﹑软件部分

  1. 说明
  2. 模板

八﹑测试

1﹑测试流程

2﹑测试要求

  1. 硬件部分
  2. 软件部分

3﹑测试模板

  1. 硬件部分
  2. 软件部分

九﹑从研发到产品的过渡

  1. 要求
  2. 模板

十﹑技术支持

  1. 要求
  2. 模板

十一﹑文档工作的评估与审核

显示全文