技术研发文档模版0.10

《技术研发文档模版0.10》由会员分享，可在线阅读，更多相关《技术研发文档模版0.10（26页珍藏版）》请在金锄头文库上搜索。

1、*公司 技术文档规范 公司 技术研发中心 1第一部分 总纲一目 的：（1） 规范公司内部技术研发工作的文档管理；（2） 保持技术研发工作的完整性与连续性；（3） 防止技术流失，减少风险；（4） 使技术文档成为技术研发工作中的重要组成部分。二适用范围：本公司内部一切与技术研发有关的部门及个人，包括（1） 总经理；（2） 技术部门经理或负责人；（3） 研发工程师；（4） 测试工程师；（5） 技术支持工程师。三目 标：通过切实可行的文档管理规范，使得研发工作透明，明确，有章可循，合作无障碍，衔接环节畅通；使得所有的研发产品从开始研发研发进程测试修改阶段性结束产品转化升级维护过程中的所有环节都得以在相

2、应的文档中体现。四版 本：称 。五制定原则：（1） 实用：鉴于公司目前的状况，通用性的开发模板（如国标）在很大程度上对于本公司并不实用，所以本规范将不会完全照搬此类模板，而是根据公司的具体情况制定公司内部的标准；（2） 可行：可行性是该标准的起码要求，没有可行性的标准不能成为真正的“标准” ；（3） 高效：如果将国标中的所有规范内容都纳入本标准，一定可以达到目的，实现目标。但是，同时必将为相关人员增添大量的工作量，而且很多工作对于本公司来说是冗余，从而造成相关人员的抵触情绪，使标准难于贯彻。所以，本标准应力求在尽量少的模板中体现尽量多的内容；（4） 科学：本标准的制定虽然不完全照搬其他通用性的

3、标准，但将大量参照通用标准，特别是国标中的某些部分内容，不是抛弃国标，而是以国标为原则，以保证科学性；（5） 建立在广泛意见基础上：本标准并非公司某一个人单方面的意愿，而是从公司利益出发，全体相关人员共同参与，集体的结晶。六实行过程及生效日期：（1） 的规范为规范草稿，草稿制订完成后，将在相关部门和相关人员中进行传阅和广泛征求意见。经过三次全体相关人员*公司 技术文档规范 公司 技术研发中心 2参与讨论和修改，由总经理审批签字后的规范版本为 2） 试用版本，在 试用过程中，将要求并给予相关人员以合理的时间尽量按照 的要求规范修改，补充和完善 以前（包括 前欠缺的文档）的有价值文档。在此期间，如

4、有新的研发工作开始启动，将要求相关人员按照 的规范要求进行文档的相关操作。在此过程中，如果发现规范中需要修改和补充之处，每经过一次大幅度的修改，版本即升级到 i=1,2,3,n,） ，每经过一次小的修改或补充，版本将升级为 j=1,2,3,n ） 。（3） 正式版本。此时的版本已经经过讨论，试用，修改，补充和不断完善，并且 前欠缺的文档与 用过程中的文档都已经按照 本的要求整理完毕，此时的 已经成熟，可以整体升级到 。本的文档规范将作为公司内部与技术研发工作相关的所有人员在今后相当一段时间内共同遵守的规范，并且将文档的撰写工作作为技术研发的一个重要组成部分正式纳入到技术研发工作中。（4） 范将

5、具有强制性和高约束力。（注：i=0,1,2, 表示 i 版本系列；i，m，n=0 ，1，2，表示 i 版本系列下的改动或升级）*公司 技术文档规范 公司 技术研发中心 3第二部分 目录索引一版本控制规则二立项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测试模板*公司 技术文档规范 公司 技术研发中心 4（1） 硬件部分（2） 软件部分九从研发

6、到产品的过渡（1） 要求（2） 模板十技术支持（1） 要求（2） 模板十一文档工作的评估与审核（1） 评估标准（2） 审核要点*公司 技术文档规范 公司 技术研发中心 5第三部分 内容一版本控制规则（1） 版本状态：试版，式版，变更（2） 版本号：版本号以三位数字表示，格式为 i=0 ，1，2，n；1 ，99）a. ，i=0b. 第一次正式发布的 ， 用 表示 本的修改或升级d. 小的改动或升级 i，j 保持不变，只增加 k 值即可，k 的升值幅度为修改或升级处的数目，当 k 值达到或增加至 9 时，j=j+1，k=0e. 比较大的改动如，一次修改或升级处的数目10，功能性的增加或改变，则 i

7、 保持不变，增加 j 值。如果是功能性的修改或变动，每有一项 j+1；如果是10 的非功能性的修改，每 10 处修改， j+1，个数部分用 k 来表示f. 重大变动，i 值增加g. 累计功能变动超过百次，i+1，0*公司 技术文档规范 公司 技术研发中心 6二立项立项管理（目的是采纳符合公司最大利益的立项建议，通过立项管理使该建议成为正式的项目（合法化） 。杜绝不符合公司最大利益的立项建议被采纳，避免公司人力资源的，资金，时间的浪费。立项管理是决策行为，目标是“做正确的事情” （do 。而立项之后的研发管理活动是保证项目团队“正确地做事情”(do “正确的决策”+ “正确地执行”才有可能产生好

8、的产品。1说明：（1） 立项：任何一次研发工作的启动，包括全新的项目和在以往的项目基础上进行升级或改版的项目，都需要进行立项的工作。（2） 项目分级：为了明晰立项的工作，使之有条理，可操作，所以将项目区分为一级项目和二级项目两个不同的等级a一级项目：包括全新的项目的启动，原有项目的重大改版和升级b二级项目：在以往项目的基础上进行的非重大的版本修改和完善（3） 项目审批：a 所有一级项目必须由项目负责人提交项目申请计划书，并就项目的相关情况向总经理和技术总监书面陈述或面对面沟通，得到总经理和技术总监的审批签字后方能启动；b 一级项目必须附加需求分析与可行性分析c 二级项目可以由部门经理指定或由项

9、目负责人申请得到部门经理审批签字后即可执行，不必交由总经理和技术总监审批签字；d对于二级项目，必须将项目计划申请书（纸介质）交由技术文档负责人归档，总经理及技术总监对二级项目的进展情况具有知情权，而项目负责人具有向总经理和技术总监汇报（主动或被动）项目相关情况的义务；e项目申请计划书一式两份：纸介质文档与电子文档。纸介质文档作为技术档案由专门负责人员备份归档。电子文档按规范要求存储在公司指定的文档服务器上。（4） 权利，责任与义务a 总经理，技术总监，部门经理对其所具有审批权限的项目申请计划书具有否决的权利；b 项目申请人有权要求否决人说明被否决的理由，而且否决人必须在被否决的项目申请计划书中

10、陈述否决理由；c 具有审批权限的人对于项目的合理性，需求性，可行性等判断负有全权责任；2项目申请计划书*公司 技术文档规范 公司 技术研发中心 7项目申请计划书/ 立项建议书项目编号 别 一级项目 二级项目 类 别 指定项目 申请项目 版本说明 人 请日期 2003u 组 成 员 于 图像传输 产品名称，源配置需求理由陈述成本简要核算 （暂时可不添此项）近 期（年月日 年月日）中 长 期（年月日 年月日）远 期（年月日 年月日）目 标问 题（在此陈述进行该项目可能遇到和需要解决的问题，除了技术层面外，还包括设备，人员配备等方方面面的主要问题）问题与解决解决方法 针对以上的问题，提出解决建议备注

11、说明审批结果 通过 否决 审批日期 审批人签字审批意见*公司 技术文档规范 公司 技术研发中心 8三需求分析：如果说立项管理是为了解决 do do 问题，那么需求分析就是要解决 do 问题。需求产生目标，目标引领方向。好的需求分析不仅要解决“需要做什么” ，同时明确“什么不需要做” 。最好的，可能产生最大利益的产品是“恰如其分”的产品。所谓“恰如其分”就是：产品的功能恰好满足那些特定的需求，产品功能不多也不少。一般的情况下，总结出“需好做什么”比区分“什么不需要做”要来的容易，但“什么不需要做”的界定往往会影响到成本投入和利益产出的比例。1说明：（1） 需求分析工作的安排：进行一项产品的开发工

12、作的一般流程应该是：市场调查需求分析可行性研究立项审核概要设计（总体设计）详细设计单元测试集成测试修改完善项目评估，审核批量生产投放市场技术支持与售后服务。（2） 需求的种类：需求的本质上都来源于市场，但是在具体表现上又有所不同。有的需求直接由用户提出，目标明确；而有些需求则是我们从市场的零星反馈中总结出来的，带有预见性和自主性。（3） 需求分析的主要目的：从市场的反馈或对市场的观察与预见中总结出市场的需求，并用理性的思维对这些需求进行分析和总结，将需求明确，为后面的工作奠定基础。（4） 需求分析的作用：需求分析是市场与技术的转换点。经过需求分析后，工作的重心即由市场转移到技术，明确的需求分析是真正进行研发工作的起点，是进行产品开发一系列后序工作的基础。（5） 需求在进行研发的过程中如果发生变更，需要填写“需求变更说明书”*公司 技术文档规范 公司 技术研发中心 92模板 1需求分析说明书/