技术研发文档模版0.20

《技术研发文档模版0.20》由会员分享，可在线阅读，更多相关《技术研发文档模版0.20（8页珍藏版）》请在装配图网上搜索。

1、编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第8页 共8页第一部分 前言 在第一次研发中心内部（技术二部）的广泛讨论与征求意见的基础上，经过总结，形成“技术文档规范EY2003-11-V0.20”。改动部分大体有以下几个方面：（1） “配置编号”编制规则；（2） “需求分析说明书/报告”，模板部分（3） 在需求部分以附件的形式增加 “最新需求确定” 模板，由技术研发中心 苏正华负责起草（4） 统一文档原创者身份为 “作者”（5） 文档模板中统一一项内容 “产品名称”（6） “需求/功能变更说明书” 模板中增加 “负责人签字” 项（7） “数据库设计报告（S）” 模板 增加

2、 “主键” 项，“关联关系描述”项，存储过程项，触发器项（8） 产品测试报告（SP1）与（SP2）合并为一套模板，并在 测试项 遗留问题项 中有多处变动，新增 新问题 项（9） 以 附件 形式 增加 “测试方案” 模板， 由由技术研发中心 苏正华负责起草（10） 在 V0.10 的 “第三部分 内容” 第一项 “版本控制规则” 中 版本号 增为4位数字（11） 在 V0.10 的 “第三部分 内容” 第七项 “详细设计” 中 有关代码文件的说明 部分 增加 注释 改动内容 项 在本版中，将不再有V0.10中解释与说明的部分，缺少的必要部分将补充到本版中。 第一部分 变动内容说明一版本控制规则（

3、1） 版本状态：Alfa ，Beta，Deta/内部测试版，Release/对外正式发布版，Changing/内部变更状态（2） 版本号：版本号以四位数字表示，格式为i.jk.l（i=0，1，2，n；jkl=001，999）a. Alfa版，i=0b. 第一次正式发布的Release版，1.00c. 用Changing来表示内部测试版或Release版本的内部修改或升级状态d. 小的改动或升级i，jk保持不变，只增加l值即可，l的升值幅度为修改或升级处的数目，当l值达到或增加至9时，l=l+1，l=0e. 比较大的改动如，一次修改或升级处的数目10，功能性的增加或改变，则i.j保持不变，增加k

4、值。如果是功能性的修改或变动，每有一项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

5、. 文档配置编号由专业技术秘书或技术文档管理员 统一分配制定。b. H，表示硬件；S，表示软件c. A，表示附件；如果有多个附件，则从01开始依次编制。如果没有附件，省略三需求分析说明书/报告需求分析说明书/报告配置编号EPD2003NoX-02-S-01作者提交时间2003-8-18产品名称目标用户陈述产品的目标用户需求陈述内容级别1A B C2解决方法简单描述针对需求的初步解决意向附加说明讨论意见项目评审委员会结论四需求/功能变更 说明书需求/功能变更 说明书配置编号EPD2003NoX-02-S-02当前版本V2.17历史版本V2.00产品名称作者时间2003-8-19变更项变更内容变更

6、属性变更理由陈述是否允许1A D M是 否23附加说明变更属性中A代表增加，D代表删除，M代表修改项目评审委员会结论项目评审委员会给出是否进行变更的意见，由评委会主席签字生效负责人签字最新需求确定模板，附件五数据库设计报告（S）数据库设计报告（S）配置编号EPD2003NoX-05-S-01作者时间2003-8-19当前版本V1.20历史版本V1.17表汇总表名功能描述1A2B3CA列名(主键)数据类型（精度范围）约束条件备注12补充说明角色与权限可以访问的表与列访问权限角色A角色B关联关系描述存储过程名称脚本描述用途12触发器名称脚本描述用途12六功能定义说明书功能定义说明书配置编号EPD2

7、003NoX-04-S-01作者提交时间2003-8-19产品名称当前版本历史版本功能项功能名称功能描述123附加说明项目评审委员会意见项目评审委员会给出整体意见，供决策人参考负责人签字七功能定义变更说明书功能变更说明书配置编号EPD2003NoX-04-S-02作者提交时间2003-8-19产品名称当前版本历史版本变更项原功能名称新功能名称变更属性变更理由陈述是否允许1A D M是 否23附加说明项目评审委员会意见项目评审委员会给出整体意见，供决策人参考负责人签字最新功能定义说明书模板，附件八概要设计概要设计报告（S）配置编号EPD2003NoX-05-S-01作者提交时间2003-8-19

8、产品名称V1.20当前版本ChangingV1.17历史版本ReleaseV1.07术语与缩写解释术语解释G-BIAS即GPS-Based Integrated Application System设计约束系统应当遵循的标准或规范软硬件环境（包括运行环境与开发环境）的约束接口/协议的约束用户界面的约束*软件质量约束，包括正确性，健壮性，可靠性，效率（性能），易用性，清晰性，安全性，可扩展性，兼容性，可移植性。（如果有约束，逐一填写；如果不存在约束，可不填）设计策略扩展策略为了方便扩展，现在采取的措施复用策略说明本系统在当前以及将来的复用策略折衷策略如果存在两个主要目标难以同时优化时如何折衷系统

9、总体结构描述凡是用图表示的部分，均用MS Visio2002绘制，左边为图，右边为文字说明开发环境配置软件硬件网络主要开发工具及语言运行环境要求软件包括操作系统，第三方软件平台硬件网络数据库参考资料资料配置编号来源12其他说明九产品测试报告产品测试报告（ST1）配置编号EPD2003NoX-07-S-01-01测试人测试时间2003-8-21产品名称版本历史版本测试环境及工具操作系统网络环境支持软件硬件设备及版本其他测试项功能是否通过问题级别备注1Yes NoR Y O2问题项功能问题描述测试流程原因分析nm新问题问题描述问题级别测试流程原因分析1R Y O测试结论测试人签字手写测试反馈报告产

10、品测试反馈报告（ST2）配置编号EPD2003NoX-07-S-02-01作者测试时间产品名称版本历史版本问题项功能问题原因是否解决解决方法mYes Non附加说明负责人签字手写开发人员签字手写十有关代码文件的说明 部分 增加 注释 改动内容 项（1） 所有的代码模块必须用文件的方式组织（2） 在每一个文件中的开头以注释的方式写如下内容：Copyright（c）2003，*公司，硬件开发部*All rights reserved*文件名称：*文件标识：文件标识可以统一规定，也可以自己选择*摘 要：简要描述该文件的内容*当前版本：*作 者：输入作者或修改者的名字*改动说明：*完成日期：*取代版本

11、：*原作者 ：*完成日期：（3） 如果用C语言开发a. 必须将.H文件与.C文件区分开来，在.H中定义全局变量，结构，联合，自定义群体等，如链表；函数的声明b. 在定义函数体前，以注释方式写如下内容*函数的主要作用*输入输出参数的含义（4） 全局变量的定义要集中，并说明用途（5） 主要变量必须在定义之后说明用途（6） 所有函数的定义必须给出函数的作用sample:/*Copyright (c) XXX*All rights reserved.*Author :XXX*e-mail : christiansxy*file name : CADOClass.h*Current version: 1.0.0*Abstract : The wrapper class CADOClass will *implement the DB performance.*Complete Date: 2001-11*/第 8 页 共 8 页