技术研发文档模版0.20VIP专享VIP免费

第1页共8页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第1页共8页第一部分前言在第一次研发中心内部（技术二部）的广泛讨论与征求意见的基础上，经过总结，形成“技术文档规范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=0b.第一次正式发布的Release版，1.00c.用Changing来表示内部测试版或Release版本的内部修改或升级状态d.小的改动或升级i，jk保持不变，只增加l值即可，l的升值幅度为修改或升级处的数目，当l值达到或增加至9时，l=l+1，l=0e.比较大的改动如，一次修改或升级处的数目>10，功能性的增加或改变，则i.j保持不变，增加k值。如果是功能性的修改或变动，每有一项k+1；如果是>10的非功能性的修改，每9处修改，k+1，个数部分用l来表示f.重大变动，j值增加g.在Alfa版状态下，如果变动累计超出999次，则Alfa版升级到Beta版，依次类推第2页共8页第1页共8页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第2页共8页二﹑配置编号编制规则及说明（1）编制规则：格式：EPD+年份+-所在年份项目号+“-“+模板序号+“-“+H/S+“-“+模板编号+“-”+附件标示A+”-“+附件编号举例：EPD2003No5-05-S-01-A-01，表示2003年第5号项目的第5份模板，是软件部分的模板，当前模板为为第5份模板的第1部分（2）说明：a.文档配置编号由专业技术秘书或技术文档管理员统一分配制定。b.H，表示硬件；S，表示软件c.A，表示附件；如果有多个附件，则从01开始依次编制。如果没有附件，省略三﹑需求分析说明书/报告需求分析说明书/报告配置编号EPD2003NoX-02-S-01作者提交时间2003-8-18产品名称目标用户陈述产品的目标用户需求陈述内容级别1□A□B□C2解决方法简单描述针对需求的初步解决意向附加说明讨论意见项目评审委员会结论第3页共8页第2页共8页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第3页共8页四﹑需求/功能变更说明书需求/功能变更说明书配置编号EPD2003NoX-02-S-02当前版本V2.17历史版本V2.00产品名称作者时间2003-8-19变更项变更内容变更属性变更理由陈述是否允许1□A□D□M□是□否23附加说明变更属性中A代表增加，D代表删除，M代表修改项目评审委员会结论项目评审委员会给出是否进行变更的意见，由评委会主席签字生效负责人签字最新需求确定模板，附件五﹑数据库设计报告（S）数据库设计报告（S）配置编号EPD2003NoX-05-S-01作者时间2003-8-19当前版本V1.20历史版本V1.17表汇总表名功能描述1A2B3CA列名(主键)数据类型（精度范围）约束条件备注12补充说明第4页共8页第3页共8页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第4页共8页角色与权限可以访问的表与列访问权限角色A角色B关联关系描述存储过程名称脚本描述用途12触发器名称脚本描述用途12六﹑功能定义说明书功能定义说明书配置编号EPD2003NoX-04-S-01作者提交时间2003-8-19产品名称当前版本...