00A 软件设计技术规定.doc

济南琛润网络科技有限公司 软件设计技术规定 文件编号: CR_PROC/TP 目 录 一、技术文件及附图编码 3 二、关于图纸的表示 6 三、关于程序模块、组件、函数等描述 12 一、技术文件及附图编码 技术文件及附图、插图要编码，其规则为： 1、软件过程与管理办法 CR_PROC/XXXX/VX.X CR—琛润 PROC—过程；PRES—规定。 XXXX： OVER——过程综述和政策 TM——培训管理过程 BM——合同管理过程 RM——需求管理过程 PMGM——项目管理过程 QA——质量保证过程 CM ——配置管理过程 MRP——项目管理评审过程 WPR——工作产品评审过程 SEL——软件工程过程 TP——技术规定 2、文件名命名规定： 与文件的自然名一致，现在可能应用的文件有以下文件： 项目可行性分析报告/解决方案 项目建议书 技术合同书 需求规格说明书 概要设计书 单元设计规格说明书（详细设计书） 设计说明书（概要设计+详细设计） 项目管理计划 项目质量保证计划 项目状态报告 项目配置管理计划 项目关闭报告 发布申请和报告 安装和转换备忘录 系统管理员操作手册 用户操作手册 验收测试计划 编程技术规定 系统测试计划 系统测试总结报告 BUG报告/BUG用例 需求分析计划 系统初始原型 系统集成代码 客户验收计划 客户验收报告 培训计划 对进入基线的文件版本号在VSS系统中标记；打印文本在页眉的“文件编号”中标记。 对于不进入基线的文件，如果是同一个文件改变后要求保留前一个版本，则由VSS系统生成版本，加以区别。 对于同一个文件名，出现在软件过程的不同阶段，则用“文件名_阶段名”以示区别。如“状态报告_需求阶段”、“状态报告_设计阶段”、┅┅。\ 关于版本编号（Vx.xx—版本号）的规定： 初始版本：V0.1D。 工作产品及原代码的未发布版本与配置项标签号一致，为0.1、0.2、0.3 ┅ ┅递增。 规定发布的第一个系统版本为1.0，它对应的原代码配置项标签号也为1.0；以后每变更一次，系统版本和变更原代码标签号依次为1.1、1.2、1.3 ┅ ┅递增；较大的变更引起版本号修改应由配置控制批准定为2.0、3.0 ┅ ┅等。 变更涉及需求、设计文档的相应变更，其版本号与配置标签一致，在原来的版本号上递增；它与发布的系统原代码的对应关系用下表关联，体现到单元设计/编码/集成测试后的配置项状态表中 对一些有编号的特殊文件可用“文件名+（文件编号）”、“文件名+建立日期”、组成。如“变更请求表“表示成：“变更请求表（001）”、“项目审计报告040311”表示成“项目审计报告040311”、┅┅。 3、文件编码： CR_DFEIP_1003_X_X/X CR—琛润 JNGA—济南公安项目，由汉字拼音第一个字符大写及缩写组成。 1003—立项年月 X—实际阶段：0，可行性研究；1，需求分析；2，概要设计；3，详细设计；4，设计（概要设计与详细设计合并）；5，系统测试；6，安装/验收测试（要求）/转换/移交/维护。 X——表示文档名称码： 项目可行性分析报告/解决方案 项目建议书 技术合同书 需求规格说明书 概要设计书 单元设计规格说明书（详细设计书） 设计说明书（概要设计+详细设计） 项目管理计划 项目质量保证计划 项目状态报告 项目配置管理计划 项目关闭报告 发布申请和报告 安装和转换备忘录 系统管理员操作手册 用户操作手册 验收测试计划 编程技术规定 系统测试计划 系统测试总结报告 BUG报告/BUG用例 需求分析计划 系统初始原型 系统集成代码 客户验收计划 客户验收报告 培训计划 /X表示版本号：如V1.0 不进入基线的工作产品不加“/X”——版本号 二、关于图纸的表示 1、客户组织结构：企业的组织结构图 其中： “*”表示单位是该管理业务的主要完成单位 “X”表示单位是该管理业务的铺助完成单位 “√”表示单位是该管理业务的相关完成单位 “空”表示单位是该管理业务的无关单位 3、业务功能一览表 4、业务流程分析 基本符号 业务流程图 业务流程图举例： （3）DFD（数据流程）图 顶层IOP图 HIPO图 模块IOP图 A B 面向对象设计图形画法按UML（统一建模语言）标准执行 类图 use case图 时序图 交互图 状态图 模型图 以上图形都应当有详细的文档说明。 三、关于程序模块、组件、函数等描述 命名 功能描述 输入与输出参数表字典：ID，参数名，属性，取值范围，出错信息。 调用关系字典：ID，调用名，调用说明。 处理流程。 济南琛润网络科技有限公司 软件设计技术规定 文件编号：CR_PRES/TP 第 12 页 共 1