技术研发文档模版0.20
第一部分 前言 在第一次研发中心内部（技术二部）的广泛讨论与征求意见的基础上，经过总结，形成 “技术文档规范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=0 b. 第一次正式发布的Release版，1.00 c. 用Changing来表示内部测试版或Release版本的内部修改或升级状态 d. 小的改动或升级i，jk保持不变，只增加l值即可，l的升值幅度为修改或升级处的 数目，当l值达到或增加至9时，l=l+1，l=0 e. 比较大的改动如，一次修改或升级处的数目>10，功能性的增加或改变，则i.j保持 不变，增加k值。如果是功能性的修改或变动，每有一项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. 文档配置编号由专业技术秘书或技术文档管理员 统一分配制定。 b. H，表示硬件；S，表示软件 c. A，表示附件；如果有多个附件，则从01开始依次编制。如果没有附件，省略 三﹑需求分析说明书/报告 |需求分析说明书/报告 | |配置编号 |EPD2003NoX-02-S-01 |作者 | |提交时间 |2003-8-18 | |产品名称 | |目标用户 |陈述产品的目标用户 | |需求陈述 | |内容 |级别 | | |1 | |□A □B □C| | |2 | | | | | | | | |解决方法 |简单描述针对需求的初步解决意向 | |附加说明 | | |讨论意见 | | |项目评审委| | |员会结论 | | 四﹑需求/功能变更 说明书 |需求/功能变更 说明书 | |配置编号 |EPD2003NoX-02-S-02 |当前版本 |V2.17 |历史版本 |V2.00 | |产品名称 | |作者 | |时间 |2003-8-19 | |变更项 | |变更内容 |变更属性 |变更理由陈述 |是否允许 | | |1 | |□A □D □M | |□是 □否 | | |2 | | | | | | |3 | | | | | |附加说明 |变更属性中A代表增加，D代表删除，M代表修改 | |项目评审委|项目评审委员会给出是否进行变更的意见，由评委会主|负责人签字| | |员会结论 |席签字生效 | | | 最新需求确定模板，附件 五﹑数据库设计报告（S） |数据库设计报告（S） | |配置编号 |EPD2003NoX-05-S-01 |作者 | |时间 |2003-8-19 | |当前版本 |V1.20 |历史版本 |V1.17 | |表汇总 | |表名 |功能描述 | | |1 |A | | | |2 |B | | | |3 |C | | |A | |列名(主键) |数据类型（精度范 |约束条件 |备注 | | | | |围） | | | | |1 | | | | | | |2 | | | | | | |补充说明 | |角色与权限 | |可以访问的表与列 |访问权限 | | |角色A | | | | |角色B | | | |关联关系描述 | | |存储过程 | |名称 |脚本描述 |用途 | | |1 | | | | | |2 | | | | |触发器 | |名称 |脚本描述 |用途 | | |1 | | | | | |2 | | | | 六﹑功能定义说明书 |功能定义说明书 | |配置编号 |EPD2003NoX-04-S-01 |作者 | |提交时 |2003-8-19 | | | | | |间 | | |产品名称 | |当前版本 | |历史版 | | | | | | |本 | | |功能项 | |功能名称 |功能描述 | | |1 | | | | |2 | | | | |3 | | | |附加说明 | | |项目评审委|项目评审委员会给出整体意见，供决策人参考 |负责人签 | | |员会意见 | |字 | | 七﹑功能定义变更说明书 |功能变更说明书 | |配置编号 |EPD2003NoX-04-S-02 |作者 | |提交时间 |2003-8-19 | |产品名称 | |当前版本 | |历史版本 | | |变更项 | |原功能名称 |新功能名称 |变更属性 |变更理由陈述 |是否允许 | | |1 | | |□A □D □M | |□是 □否 | | |2 | | | | | | | |3 | | | | | | |附加说明 | | |项目评审委|项目评审委员会给出整体意见，供决策人参考 |负责人签 | | |员会意见 | |字 | | 最新功能定义说明书模板，附件 八﹑概要设计 |概要设计报告（S） | |配置编号 |EPD2003NoX-05-S-01 |作者 | |提交时 |2003-8-19 | | | | | |间 | | |产品名称 |V1.20 |当前版本 |ChangingV1.1|历史版 |ReleaseV1.| | | | |7 |本 |07 | |术语与缩写解 |术语 |解释 | |释 | | | | |G-BIAS |即GPS-Based Integrated Application System | | | | | |设计约束 |﹡系统应当遵循的标准或规范 | | |﹡软硬件环境（包括运行环境与开发环境）的约束 | | |﹡接口/协议的约束 | | |﹡用户界面的约束 | | |*软件质量约束，包括正确性，健壮性，可靠性，效率（性能），易用性，清| | |晰性，安全性，可扩展性，兼容性，可移植性。 | | |（如果有约束，逐一填写；如果不存在约束，可不填） | |设计策略 |﹡扩展策略—为了方便扩展，现在采取的措施 | | |﹡复用策略—说明本系统在当前以及将来的复用策略 | | |﹡折衷策略—如果存在两个主要目标难以同时优化时如何折衷 | |系统总体结构 |凡是用图表示的部分，均用MS Visio2002绘制，左边为图，右边为文字说明 | |描述 | | |开发环境配置 |软件 | | | |硬件 | | | |网络 | ...
技术研发文档模版0.20