软件研发规范.docx

2022-4-26 同方电力事业部 页 页码 1/5 密级 审核 版本/日期 拟制 柳涛 文件号 软件开辟规范 批准 目 录 一、前言 二、文档规范篇 1. 概述 2. 文档与软件开辟过程 3. 文档规范 3.1. 需求规格说明 3.2. 概要设计说明 3.3. 详细设计说明 3.4. 数据库设计说明 3.5. 测试计划 3.6. 测试设计说明 3.7. 测试用例说明 3.8. 测试总结报告 3.9. 系统指南 3.10. 用户操作手册 三、编码规范篇 1. 概述 ―――――――――――――――――――――――――――――――――――――――――――――――――― 同方电力事业部 同方电力事业部 2022-4-26 同方电力事业部 页 页码 2/5 密级 审核 版本/日期 拟制 柳涛 文件号 软件开辟规范 批准 2. 编码规范 2.1. 命名规范 2.2. 编程结构描述 2.2.1. 注释 2.2.2. 函数注释 2.2.3. 条件执行语句 if…else 2.2.4. 重复执行 while 和跳转语句 goto 2.2.5. 书写格式 2.2.6. 字体 2.2.7. 数据对象的国际化 3. 软件开辟规范的控制 ―――――――――――――――――――――――――――――――――――――――――――――――――― 2022-4-26 同方电力事业部 页 页码 3/5 密级 审核 版本/日期 拟制 柳涛 文件号 软件开辟规范 批准 第一章 前言 ―――――――――――――――――――――――――――――――――――――――――――――――――― 同方电力事业部 同方电力事业部 2022-4-26 同方电力事业部 页 页码 4/5 密级 审核 版本/日期 拟制 柳涛 文件号 软件开辟规范 批准 第二章 文档规范篇 1. 概述 软件生存期的所有阶段都要求编制文档。因此文档编制和维护是必需的并且从 软件的概念阶段连续作用到它废止。文档编制开始于软件项目的初始阶段，并贯通 于软件的设计、开辟、测试、安装、使用、修改和增强。 文档的编制是任何软件开辟项目成功的基础，并且文档的产生需要有时间、人 工和资金的支撑。管理的职责是保证这些资源有效地利用重要文档的标识以使软件 产品成功开辟并提高质量。 本章重点在于规定在软件开辟阶段各文档的编制规范。 2. 文档与软件开辟过程 测 测试 运行与维护 —— —— —— 阶段 文件 项目开辟计划 需求规格说明 概要设计说明 详细设计说明 数据库设计说明 测试计划 测试总结 系统指南 用户操作手册 开辟进度月报 项目开辟总结 需求分析 —— —— —— —— —— —— 实现 —— —— —— 设计 —— —— —— —— —— —— ―――――――――――――――――――――――――――――――――――――――――――――――――― 2022-4-26 同方电力事业部 页 页码 5/5 密级 审核 版本/日期 拟制 柳涛 文件号 软件开辟规范 批准 3. 文档规范 3.1. 需求规格说明 软件需求规格说明书 1. 引言 1.1. 项目名称 1.2. 项目背景和内容概要 (项目的委托单位、开辟单位、主管部门、与其它项目的关系，与其他 机构的关系等) 1.3. 相关资料、缩写语、定义 (相关项目计划、合同及上级机关批文，引用的文件、采用的标准，缩 写词和相关名词定义) 2. 项目概述 2.1. 被开辟软件的普通描述 (被开辟软件的主要组成部份， 相互联系和外部接口， 可用系统流程图 的层次结构描述) 2.2. 被开辟软件的功能 (简述被开辟软件的功能) 2.3. 实现语言 (列出所采用的编程语言) 2.4. 用户特点 (描述最终用户具有的受教育水平、工作经验及技术专长) 2.5. 假定条件与约束限制 (尽量列出开展本项目的假定和约束，例如：经费限制，开辟限制，设 备条件，用户现场环境准备等) 3. 业务流程 (描述项目的业务流程，可结合系统流程图进行描述) 4. 数据描述 4.1. 原始数据描述 4.1.1. 静态数据 4.1.2. 动态数据 4.2. 数据流向图 4.3. 数据概念模型和描述 ―――――――――――――――――――――――――――――――――――――――――――――――――― 同方电力事业部 2022-4-26 同方电力事业部 页 页码 6/5 密级 审核 版本/日期 拟制 柳涛 文件号 软件开辟规范 批准 5. 功能需求 5.1. 功能描述 (描述该软件功能及使用方法；列出与功能有关的背景资料) 5.2. 输入要求 a) 输入数据的描述，包括输入源、数量、度量单位和