技术研发文档模版0.10

1、*公司 技术文档规范EY-V0.10 *公司 技术研发中心 PAGE 46第一部分 总纲一目 的：规范公司内内部技术术研发工工作的文文档管理理；保持技术研研发工作作的完整整性与连连续性；防止技术流流失，减减少风险险；使技术文档档成为技技术研发发工作中中的重要要组成部部分。二适用范范围：本本公司内内部一切切与技术术研发有有关的部部门及个个人，包包括总经理；技术部门经经理或负负责人；研发工程师师；测试工程师师；技术支持工工程师。三目 标标：通过切实可可行的文文档管理理规范，使使得研发发工作透透明，明明确，有有章可循循，合作作无障碍碍，衔接接环节畅畅通；使使得所有有的研发发产品从从开始研研发研发进进

2、程测试修改阶段性性结束产品品转化升级级维护过过程中的的所有环环节都得得以在相相应的文文档中体体现。四版 本本：E220033V0.10（简简称V00.100）。五制定原原则：实用：鉴于于公司目目前的状状况，通通用性的的开发模模板（如如国标）在在很大程程度上对对于本公公司并不不实用，所所以本规规范将不不会完全全照搬此此类模板板，而是是根据公公司的具具体情况况制定公公司内部部的标准准；可行：可行行性是该该标准的的起码要要求，没没有可行行性的标标准不能能成为真真正的“标准”；高效：如果果将国标标中的所所有规范范内容都都纳入本本标准，一一定可以以达到目目的，实实现目标标。但是是，同时时必将为为相关人人

3、员增添添大量的的工作量量，而且且很多工工作对于于本公司司来说是是冗余，从从而造成成相关人人员的抵抵触情绪绪，使标标准难于于贯彻。所所以，本本标准应应力求在在尽量少少的模板板中体现现尽量多多的内容容；科学：本标标准的制制定虽然然不完全全照搬其其他通用用性的标标准，但但将大量量参照通通用标准准，特别别是国标标中的某某些部分分内容，不不是抛弃弃国标，而而是以国国标为原原则，以以保证科科学性；建立在广泛泛意见基基础上：本标准准并非公公司某一一个人单单方面的的意愿，而而是从公公司利益益出发，全全体相关关人员共共同参与与，集体体的结晶晶。六实行过过程及生生效日期期：V0.100版的规规范为规规范草稿稿，草

4、稿稿制订完完成后，将将在相关关部门和和相关人人员中进进行传阅阅和广泛泛征求意意见。经经过三次次全体相相关人员员参与讨讨论和修修改，由由总经理理审批签签字后的的规范版版本为00.400。V0.400为试用用版本，在在V0.40的的试用过过程中，将将要求并并给予相相关人员员以合理理的时间间尽量按按照V00.400版的要要求规范范修改，补补充和完完善V00.400版以前前（包括括V0.10以以前欠缺缺的文档档）的有有价值文文档。在在此期间间，如有有新的研研发工作作开始启启动，将将要求相相关人员员按照VV0.440版的的规范要要求进行行文档的的相关操操作。在在此过程程中，如如果发现现规范中中需要修修改

5、和补补充之处处，每经经过一次次大幅度度的修改改，版本本即升级级到V00.5ii（i=1,22,3,n,），每每经过一一次小的的修改或或补充，版版本将升升级为VV0.44j（jj=1,2,33,n）。V1.000为正式式版本。此此时的版版本已经经经过讨讨论，试试用，修修改，补补充和不不断完善善，并且且V1.00以以前欠缺缺的文档档与V00.400试用过过程中的的文档都都已经按按照V00.400版本的的要求整整理完毕毕，此时时的V00.400版已经经成熟，可可以整体体升级到到V1.00版版。V11.000版本的的文档规规范将作作为公司司内部与与技术研研发工作作相关的的所有人人员在今今后相当当一段时

6、时间内共共同遵守守的规范范，并且且将文档档的撰写写工作作作为技术术研发的的一个重重要组成成部分正正式纳入入到技术术研发工工作中。V1.000规范将将具有强强制性和和高约束束力。（注：Vii.000，i=0,1,22,表示i版本系系列；VVi.mmn，ii，m，nn=0，11，2，表示i版本系列下的改动或升级）第二部分 目录录索引一版本控控制规则则二立项1说明2模板三需求分分析1说明2模板四可行性性分析1说明2模板五功能定定义1说明2. 模板板六概要设设计1硬件部部分说明模板2软件部部分说明模板七详细设设计1硬件部部分说明模板2软件部部分说明模板八测试1测试流流程2测试要要求硬件部分软件部分3测

7、试模模板硬件部分软件部分九从研发发到产品品的过渡渡要求模板十技术支支持要求模板十一文档档工作的的评估与与审核评估标准审核要点第三部分 内容容一版本控控制规则则版本状态：Betta/测测试版，RReleeasee/正式式版，CChannginng/变变更版本号：版版本号以以三位数数字表示示，格式式为i.jk（ii=0，11，2，n；jk=01，99）Beta版版，i=0第一次正式式发布的的Relleasse版，11.000用Channginng来表表示Beeta或或Relleasse版本本的修改改或升级级小的改动或或升级ii，j保保持不变变，只增增加k值值即可，kk的升值值幅度为为修改或或升级处

8、处的数目目，当kk值达到到或增加加至9时时，j=j+1，kk=0比较大的改改动如，一一次修改改或升级级处的数数目110，功功能性的的增加或或改变，则则i保持持不变，增增加j值值。如果果是功能能性的修修改或变变动，每每有一项项j+11；如果果是110的非非功能性性的修改改，每110处修修改，jj+1，个个数部分分用k来来表示重大变动，i值增加累计功能变变动超过过百次，ii+1，jjk=000二立项立项管理（PProjjectt Innitiialiizattionn Maanaggemeent，PPIM）的的目的是是采纳符符合公司司最大利利益的立立项建议议，通过过立项管管理使该该建议成成为正式式

9、的项目目（合法法化）。杜杜绝不符符合公司司最大利利益的立立项建议议被采纳纳，避免免公司人人力资源源的，资资金，时时间的浪浪费。立项管理是是决策行行为，目目标是“做正确确的事情情”（doo riightt thhinggs）。而而立项之之后的研研发管理理活动是是保证项项目团队队“正确地地做事情情”(doo thhinggs rrighht)。“正确的决策”+“正确地执行”才有可能产生好的产品。1说明：立项：任何何一次研研发工作作的启动动，包括括全新的的项目和和在以往往的项目目基础上上进行升升级或改改版的项项目，都都需要进进行立项项的工作作。项目分级：为了明明晰立项项的工作作，使之之有条理理，可操

10、操作，所所以将项项目区分分为一级级项目和和二级项项目两个个不同的的等级a一级项项目：包包括全新新的项目目的启动动，原有有项目的的重大改改版和升升级b二级项项目：在在以往项项目的基基础上进进行的非非重大的的版本修修改和完完善项目审批：a 所有有一级项项目必须须由项目目负责人人提交项项目申请请计划书书，并就就项目的的相关情情况向总总经理和和技术总总监书面面陈述或或面对面面沟通，得得到总经经理和技技术总监监的审批批签字后后方能启启动；b 一级级项目必必须附加加需求分分析与可行性性分析c 二级级项目可可以由部部门经理理指定或或由项目目负责人人申请得得到部门门经理审审批签字字后即可可执行，不不必交由由总

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

12、目申请人人有权要要求否决决人说明明被否决决的理由由，而且且否决人人必须在在被否决决的项目目申请计计划书中中陈述否否决理由由；c 具有有审批权权限的人人对于项项目的合合理性，需需求性，可可行性等等判断负负有全权权责任；2项目申申请计划划书项目申请计计划书/立项建建议书项目编号EPF20003NNOX-01级 别 eq oac(,)一级项项目 二级项项目 类 别指定项目目 eq oac(,)申请项项目版本说明V0.100申 请 人人Su申请日期2003-8-118负责人Su组 成 员员Su,Zhhangg,Yuu项目名称基于GPRRS的图图像传输输产品名称G-BIUU（Haardwwaree，GP

13、PRS-Bassed Imaage Uniit），GG-BIIUSTT(Sooftwwaree，G-BIUU Suuppoort Tooolkiit)理由陈述资源配置需需求成本简要核核算（暂时可不不添此项项）目 标近 期（年月日 年月月日）中 长长 期（年月日 年月月日）远 期（年月日 年月月日）问题与解决决问 题（在此陈述述进行该该项目可可能遇到到和需要要解决的的问题，除除了技术术层面外外，还包包括设备备，人员配备等等方方面面面的主主要问题题）解决方法针对以上的的问题，提提出解决决建议备注说明审批结果通过 否决审批日期审批人签字字审批意见三需求分分析：如果说立项项管理是是为了解解决doo r

14、iightt thhinggs和ddo tthinngs rigght的的问题，那那么需求求分析就就是要解解决doo whhat thiingss的问题题。需求求产生目目标，目目标引领领方向。好好的需求求分析不不仅要解解决“需要做做什么”，同时时明确“什么不不需要做做”。最好好的，可可能产生生最大利利益的产产品是“恰如其其分”的产品品。所谓谓“恰如其其分”就是：产品的的功能恰恰好满足足那些特特定的需需求，产产品功能能不多也也不少。一一般的情情况下，总总结出“需好做做什么”比区分分“什么不不需要做做”要来的的容易，但但“什么不不需要做做”的界定定往往会会影响到到成本投投入和利利益产出出的比例例。

15、1说明：需求分析工工作的安安排：进进行一项项产品的的开发工工作的一一般流程程应该是是：市场场调查需求分分析可行性性研究立项审审核概要设设计（总总体设计计）详细设设计单元测测试集成测测试修改完完善项目评评估，审审核批量生生产投放市市场技术支支持与售售后服务务。需求的种类类：需求求的本质质上都来来源于市市场，但但是在具具体表现现上又有有所不同同。有的的需求直直接由用用户提出出，目标标明确；而有些些需求则则是我们们从市场场的零星星反馈中中总结出出来的，带带有预见见性和自自主性。需求分析的的主要目目的：从从市场的的反馈或或对市场场的观察察与预见见中总结结出市场场的需求求，并用用理性的的思维对对这些需需

16、求进行行分析和和总结，将将需求明明确，为为后面的的工作奠奠定基础础。需求分析的的作用：需求分分析是市市场与技技术的转转换点。经经过需求求分析后后，工作作的重心心即由市市场转移移到技术术，明确确的需求求分析是是真正进进行研发发工作的的起点，是是进行产产品开发发一系列列后序工工作的基基础。需求在进行行研发的的过程中中如果发发生变更更，需要要填写“需求变变更说明明书”2模板11需求分析说说明书/报告配置编号EPF20003NNOX-02作者提交时间2003-8-118目标用户陈述产品的的目标用用户需求陈述内容级别1A B C2解决方法简单描述针针对需求求的初步步解决意意向附加说明讨论意见项目评审委委

17、员会结结论A需求：紧紧急，重重要B需求：重重要，不不紧急C需求：非非A,BB类需求求模板2需求/功能能变更 说明书书配置编号EPF20003NNOX-02-01历史版本V2.000改后版本V2.177产品名称G-BIUU(GPPRS-Bassed Imaage Uniit)负责人时间2003-8-119变更项变更内容变更属性变更原因是否允许1A D M是 否23附加说明变更属性中中A代表表增加，DD代表删删除，MM代表修修改项目评审委委员会结结论项目评审委委员会给给出是否否进行变变更的意意见，由由评委会会主席签签字生效效四技术可可行性分分析 可行性性分析是是进行研研发工作作的重要要环节，详详细

18、周到到的可行行性分析析与论证证为即将将启动的的项目把把握一道道至关重重要的关关口。技术可行性性分析要要求从技技术层面面上分析析论证项项目的可可行性，即即能否“做得到到，做得得快，做做得好”。可行行性分析析报告由由项目申申请责任任人总结结，撰写写，并提提交到项项目评审审委员会会审阅。有项目申请请/建议议书，需需求定义义和需求求报告仍仍然不能能进行实实质性的的开发，必必须要进进行可行行性分析析，可行行性分析析包括几几个部分分市场分析：分析总结市市场的发发展趋势势，说明明产品处处于市场场的什么么发展阶阶段，粗粗略估计计产品的的生命周周期本产品和同同类产品品的价格格比对统计产品当当前市场场总额，竞竞争

19、对手手所占的的份额，分分析本产产品有哪哪些比较较优势，可可能占有有多少市市场份额额为产品定位位，即确确定产品品用户群群，分析析产品消消费群体体特征，消消费方式式及影像像市场的的因素分分析政策分析分析有无相相关政策策“支持”或“限制”分析有无地地方政府府或其他他机构的的“扶持”或“干扰”竞争分析分析竞争对对手的市市场状况况，产品品的优点点与缺点点预测可能形形成的竞竞争的特特点与周周期技术可行性性分析时间和资源源可行性性分析按正常的运运作，从从产品开开发到投投入市场场，时间间上是否否来得及及计划中的人人员能否否及时到到位计划中的软软硬件需需求能否否及时到到位成本核算能能否负担担得起知识产权分分析是

20、否已经存存在某些些专利将将妨碍本本产品的的开发与与推广产品能否得得到知识识产权的的保护技术可行性性分析报报告配置编号EPF20003NNOX-03报告撰写人人提交时间2003-8-119可行性论述述由项目负责责人总结结，撰写写主要从能否否“做得到到”，“做得快快”，“做得好好”的角度度分析如果能“做做得到”，“做得快快”，“做得好好”，需要要给出通通过怎样样的方法法保证如果不能，需需要给出出理由讨论意见由技术秘书书总结撰写人提交交报告后后到项目目评审委委员会后后，项目目评审委委员组织织人员对对报告的的“可行性性论述”展开讨讨论，技技术秘书书总结各各方意见见，记述述在此栏栏项目评审委委员会意意见

21、项目评审委委员会给给出整体体意见，供供决策人人参考五功能定定义说明：功能能定义是是对doo whhat thiingss的明确确界定，是是针对明明确的需需求来定定义产品品功能的的过程。是是产品设设计的实实质性阶阶段，此此后的研研发工作作将围绕绕功能定定义展开开，功能能定义说说明书是是参与研研发的人人员进行行工作的的基础文文档，是是产品测测试与评评审，用用户手册册的编制制，市场场宣传的的主要依依据。模版功能定义说说明书配置编号EPF20003NNOX-04负责人提交时间2003-8-119功能项功能描述123附加说明项目评审委委员会意意见项目评审委委员会给给出整体体意见，供供决策人人参考六概要设

22、设计1、硬件部部分：为为了简化化操作流流程，使使文档既既能体现现设计原原理与设设计思路路，又具具有良好好的操作作性，所所以对于于硬件部部分的概概要设计计要求只只要求给给出原理理图，思路描描述，主主要器件件，主要要器件的的技术参参数。概要设计报报告（HH）配置编号EPF20003NNOX-05-H负责人时间2003-8-119原理图在此添入原原理图配配置编号号，原理理图配置置编号由由技术文文档秘书书统一编编制，编编号编制制方法待待讨论，（改动：EEPF220033NOXX-055-H-01）设计思路描描述基本要求：负责人人必须对对关键的的设计思思想进行行清楚的的描述主要器件及技术参数数器件名称用

23、途技术参数参参考123主要参考资资料资料名称来源编号12按照 重要要，关键键性器件件主要要器件辅助助性器件件的顺序序描述主主要器件件及技术术参数栏栏。每一种参考考资料都都有自己己的编号号如：EEPF220033NOXX-055-H-R12、软件部部分:软软件部分分的概要要设计需需要提交交的报告告有：概概要设计计报告，界界面设计计报告，数数据库设设计报告告概要设计报报告（SS）配置编号EPF20003NNOX-05-S-001作者提交时间2003-8-119当前版本V1.200历史版本V1.000，V11.077，V11.177术语与缩写写解释术语解释G-BIAAS即GPS-Bassed Int

24、tegrrateed AAppllicaatioon SSysttem设计约束系统应当当遵循的的标准或或规范软硬件环环境（包包括运行行环境与与开发环环境）的的约束接口/协协议的约约束用户界面面的约束束*软件质量量约束，包包括正确确性，健健壮性，可可靠性，效效率（性性能），易易用性，清清晰性，安安全性，可可扩展性性，兼容容性，可可移植性性。（如果有约约束，逐逐一填写写；如果果不存在在约束，可可不填）设计策略扩展策略略为了方方便扩展展，现在在采取的的措施复用策略略说明本本系统在在当前以以及将来来的复用用策略折衷策略略如果存存在两个个主要目目标难以以同时优优化时如如何折衷衷系统总体结结构描述述开发环

25、境配配置软件硬件网络主要开发工工具及语语言运行环境要要求软件包括操作系系统，第第三方软软件平台台硬件网络数据库参考资料资料配置编号来源12其他说明如果系统统比较复复杂，首首先将系系统分解解成若干干子系统统，对各各个子系系统绘制制逻辑图图，说明明子系统统的功能能*解释如何何以及为为什么如如此分解解系统说明子系系统间如如何如何何协调工工作，以以实现元元系统的的功能如果子系系统N仍仍然需要要分解成成模块，则则绘制模块逻逻辑图陈述分解理理由说明模块间间如何协协调工作作，从而而实现子子系统的的功能如果系统统相对简简单，给给出用工工具Viisioo绘制的的系统逻逻辑结构构图界面设计报报告界面设计报报告（S

26、S）配置编号EPF20003NNOX-05-S-002作者时间2003-8-119当前版本V1.200历史版本V1.000，v11.077，v11.177界面结构及及风格绘制界面视视图主界面：需需要给出出界面元元素的作作用与操操作子界面：给给出子界界面的主主要作用用第三方界面面元素控控件，组组件，函函数库及及其来源源名称来源作用12数据库设计计报告主主要完成成数据库库的物理理设计，即即表的结结构设计计与对表表结构的的第三范范式处理理数据库设计计报告（SS）配置编号EPF20003NNOX-05-S-003作者时间2003-8-119当前版本V1.200历史版本V1.000，v11.077，v1

27、1.177表汇总表名功能描述1A2B3CA列名数据类型（经经度范围围）约束条件备注12补充说明角色与权限限可以访问的的表与列列访问权限角色A角色B七详细设设计1. 硬件件部分，硬硬件部分分的详细细设计主主要体现现在下位位机软件件的代码码上，所所以详细细设计文文档的内内容集中中在对代代码的要要求上面面，代码码要求所有的代码码模块必必须用文文件的方方式组织织在每一个文文件中的的开头以以注释的的方式写写如下内内容：Copyrrighht（cc）20003，*公司，硬件开发部*All rigghtss reeserrvedd*文件名称称：*文件标识识：文件件标识可可以统一一规定，也也可以自自己选择择*

28、摘 要：简要描描述该文文件的内内容*当前版本本：*作 者：输入作作者或修修改者的的名字*完成日期期：*取代版本本：*原作者 ：*完成日期期：如果用C语语言开发发必须将.HH文件与与.C文文件区分分开来，在在.H中中定义全全局变量量，结构构，联合合，自定定义群体体等，如如链表；函数的的声明在定义函数数体前，以以注释方方式写如如下内容容*函数的主主要作用用*输入输出出参数的的含义全局变量的的定义要要集中，并并说明用用途主要变量必必须在定定义之后后说明用用途所有函数的的定义必必须给出出函数的的作用详细设计报报告（HH）配置编号EPF20003NNOX-06-H作者时间2003-8-220当前版本历史

29、版本所有函数定定义列表表函数定义主要用途外部接口12流程图外部接口/库接口/库名名主要用途来源12通讯协议内部通讯协协议外部协议1填入内部通通讯协议议文档配配置编号号如SMPPP，S77等2其他说明2.软件部部分软件部分的的详细设设计报告告内容相相对较多多，所以以设计报报告分成成若干部部分详细设计报报告（SSP1）配置编号EPF20003NNOX-06-S-001作者时间2003-8-220当前版本历史版本系统架构如果能用图图表示，必必须用图图表示，不不好用图图表示的的部分，可可以用文文字描述述主要控件/组件名称作用来源使用12类/结构类名作用12主要的数据据结构数据结构描述12关键算法算法作

30、用实现过程12自定义消息息消息名称消息IDInvokke条件件12其他说明 主要控控件一栏栏包括：第三方控件件，如MMapXX，FllatSStylle等，在在使用此此类控件件中必须须给出此此控件的的作用，来来源如购购买，SSharre等；必须简简要描述述此类控控件的使使用方法法，如果果控件本本身带有有资料描描述，必必须以附附录资料料的形式式给出资资料主要的类/结构：程序中中所有用用到的类类，包括括自己独独立封装装的类，从从固有的的类中集集成下来来的类，简简要陈述述类的作作用。如如果回使使用建模模工具，则则需要用用类图来来描述出出类的结结构，继继承关系系等。主要的数据据结构，如如结构（记记录）

31、，链链表，栈栈，队列列，图，树树及作用用关键算法：关键不不是复杂杂，任何何一个程程序都有有关键算算法，这这里的“关键”的引申申含义为为：主要要，重要要。必须须给出算算法的作作用与实实现的思思路过程程描述详细设计报报告（SSP2）配置编号EPF20003NNOX-06-S-002作者时间2003-8-220当前版本历史版本外部接口接口作用参数描述1Map.DDisttancce()23内部接口（方方法/函函数/过过程）接口作用宿主参数描述123其他说明所谓接口，不不过是函函数在特特定概念念下的称称谓。外外部接口口，程序序中所使使用的外外部函数数。例如如，在使使用MaapX控控件时，需需要使用用M

32、app.Diistaancee()接接口函数数来计算算距离，那那么既需需要描述述出Maap.DDisttancce()的作用用与参数数描述内部接口：所谓宿宿主，即即指包括括此接口口的自定定义或从从固有类类继承而而来的类类，如果果是全局局函数，宿宿主栏填填写G详细设计报报告（SSP3）配置编号EPF20003NNOX-06-S-003作者时间2003-8-220当前版本历史版本流程图配置编号1EPF20003NNOX-06-S-003-CCF-0012其他说明流程图主要要描述程程序的关关键流程程，对关关键的判判断依据据是：如如果没有有此流程程图描述述，则对对他人理理解此程程序存有有障碍由于流程图

33、图一般占占用较大大空间，所所以将其其作为详详细设计计报告（SSP3）的的附件八测试 测试是是产品研研发中相相当重要要的部分分，在IIT领域域越来越越受到人人们的普普遍重视视。高水水平的测测试不仅仅可以发发现表面面存在的的bugg，还可可以发现现产品内内部设计计缺陷，消消除潜在在隐患，提提出修改改完善建建议等。测测试，在在产品研研发中所所占用的的时间比比例大约约是整个个研发周周期的11/41/33。 但是，鉴鉴于公司司的实际际情况，需需要制定定有效的的，符合合公司使使用要求求，实用用的测试试规程。 产品测测试规定定为两个个部分内部测试：即指开开发人员员自己进进行的测测试工作作，基本本要求是是在一

34、般般情况下下，产品品能够正正常启动动运行即即可产品测试：当内部部测试完完成以后后，测试试人员进进行产品品测试，测测试的依依据为项项目建议议书，概概要设计计报告，功功能定义义报告，详详细设计计报告集成测试：及产品品的各个个功能部部分一起起运作下下的测试试 产品测测试在目目前看来来，最主主要的是是要测试试产品的的功能，测测试功能能的主要要依据则则是功能能定义报报告。在产品测试试前，开开发人员员必须提提供一套套测试样样本。产品测试报报告（HHP1）配置编号EPF20003NNOX-07-H-001测试人负责责人测试时间2003-8-221产品名称版本历史版本测试环境及及工具测试项功能是否通过备注1Yes No2遗留问题问题描述问题级别原因分析1R Y O2测试结论测试人签字字手写问题级别：R:即Reed，红红色级别别，重大大问题，关关键问题题，如执执行某项项功能时时，导致致系统死死机（死死循环），崩崩溃等Y:即Yeelloow，黄黄色级别别，功能能性问题题，某项项功能无无法通过过O:即Orrangge，橙橙色级别别，功能能可以实实现，但但操作十十分不便便产品测试报报告（HHP2）配置编号