研发部文档格式与规范.doc

Xxxx 公司研究所文档规范 公司公司 年年 月月 精品文档 目目 录录 1 引言 引言 2 2 文档内容规范 文档内容规范 3 系统可行性研究报告 编写内容规范 4 产品研制规范 编写内容规范 6 软件需求说明书 编写内容规范 13 硬件总体设计方案 编写内容规范 17 软件概要设计说明书 编写内容规范 面向过程 21 软件概要设计说明书 编写规范 面向对象 23 系统调试方案 编写内容规范 27 单板设计规范 编写内容规范 28 软件模块设计方案 编写内容规范 31 自测方案 编写内容规范 32 自测报告 编写内容规范 33 单板设计说明 编写内容规范 34 软件模块设计说明 编写内容规范 35 可编程器件设计说明 编写内容规范 37 单板调试说明 编写内容规范 38 软件模块调试说明 编写内容规范 39 系统调试说明 编写内容规范 40 系统测试方案 编写内容规范 41 可靠性试验方案 编写内容规范 42 系统测试规程 编写内容规范 47 系统测试报告 编写内容规范 48 可靠性报告 编写内容规范 51 项目开发总结报告 编写内容规范 53 3 文档编写格式要求 文档编写格式要求 53 4 附录 附录 56 附录 1 软件设计 IPO 图 56 附录 2 技术文件的封面样式 59 精品文档 1 1 引引言言 为了控制 文档质量 参照公司有关企业标准 对产品各阶段有关文档规范进行了 完善和补充 各文档所对应的开发阶段如下表所示 项目各阶段文档清单项目各阶段文档清单 阶段阶段文档种类文档种类 名称名称 项目 论证 1 项目可行性研究任务书 2 项目可行性研究报告 3 可行性研究评审报告 4 立项申请报告 5 研制任务书评审报告 系统 设计 1 产品研制规范 2 总体设计方案 3 硬件总体设计方案 4 软件需求说明书 5 软件概要设计说明书 面向过程 面向对象 6 数据要求和数据库设计说明书 7 系统测试方案 8 硬件测试方案 9 软件测试方案 10 自测方案 11 分系统设计方案 12 软件模块设计方案 13 产品分系统 单元及单板命名 14 单元 单板设计规范 15 系统可靠性设计说明 16 可靠性试验方案 17 整机工艺 结构设计方案 18 项目开发手册 工程 研制 1 软件模块设计 包括 2 软件模块详细设计说明 包括程序流程图或 SDL 图 3 软件模块测试说明 测试报告 4 程序代码 编译文件 运行文件及程序配置清单 5 软件模块自测报告 6 电源的技术文件 包括 电源设计说明 电源原理图 PCB 图 材料清单 电源调试说明 电源测试说明 电源测试报告 7 其它技术文件 包括 母板 背板 设计说明 原理图 PCB 图 材料清单 系统内 外连接线的说明 外购件 外协件技术要求 接续页 精品文档 工程 研制8 单元 单板的技术文件 包括 单元 单板设计说明 单元 单板软件设计说明 可编程器件 或 DSP 设计说明 单元 单板调试说明 单元 单板测试规程 原理图和 PCB 图 材料清单 单板软件程序代码 编译文件 运行文件 程序配置 单板软件清单 测试报告 9 结构设计文件 包括 单元结构设计说明 装配图和零件图 装配材料清单 整件明细表 专用件 标准件 外购件 通 借 用件汇总表 10 工艺设计文件 包括 单板及部件的工艺设计 线缆及布线工艺设计 线缆清单 11 包装设计文件 包括 包装设计说明 包装工艺说明 包装结构图 包装材料清单 12 自测报告 单板自测报告 模块自测报告 系统自测报告 13 系统调试文件 包括 系统调试说明 系统调试报告 14 系统测试文件 包括 系统测试说明 系统测试规程 软件测试规程 系统测试报告 15 集成测试文件 包括 集成测试规程 集成测试报告 16 可靠性报告 17 系统配置说明 18 工程说明和用户资料 包括 用户手册 包括技术手册 安装手册 操作维护手册 工程规范 19 样机评审报告 20 转产任务书 21 项目开发总结报告 注 文档规范可随时提出修改意见 经研究所批准后执行 2 2 文文档档内内容容规规范范 接上页 精品文档 系系统统可可行行性性研研究究报报告告 编编写写内内容容规规范范 系统可行性研究报告 是在产品调研阶段里 由研究所组织 系统设计部负责 产品 设计部门和市场体系各部门配合协助 对产品的市场需求 技术发展 技术生产能力 经 济效益 市场定位 整机功能特性等进行可行性研究的报告 可行性研究报告 作为产品 立项开发的主要依据 具体编写内容如下 1 前言 前言 描述产品相关的基本情况 2 适用范围 市场定位 适用范围 市场定位 给出产品的用户范围 3 市场情况分析 市场情况分析 根据国家建设和社会需要 通过对市场和用户的调查研究 科学地预测国内外产品 的发展状况和发展趋势 给出预期的市场容量及我们可以达到的市场占有率 并预测产品 的生命周期 4 现有产品及相关厂家情况 现有产品及相关厂家情况 应详细说明相关厂家产品的技术特点 性能指标 包括可信性指标 优缺点 成本 价格 服务及竞争力情况 5 技术能力及生产能力分析 技术能力及生产能力分析 指出公司开发此产品的相关技术和人才积累情况 开发和生产难度 现有生产线所 需改造的投入和生产能力分析 6 产品开发目标及特征 产品开发目标及特征 产品开发目标包括产品功能 性能和可信性要求 产品设计所应遵循的主要国际 国内和行业标准 产品鉴定的权威机构 7 确定零版本特性 确定零版本特性 确定提供给用户使用的零版本 或开局版本 特性 主要包括产品软硬件功能 性 能和可信性要求 8 研制周期初步分析 研制周期初步分析 初步估计产品研制各阶段时间要求 9 资源要求初步分析 资源要求初步分析 初步分析产品研制各阶段人力 财力 资金 物力 开发工具 工作场地 等资源 要求 10 产品成本与价格初步估计 产品成本与价格初步估计 精品文档 产品成本需综合考虑开发成本 元材料成本 生产成本 销售成本和维护成本 产品 价格包括目前市场平均价格 市场价格走势 主要竞争对手的成本与价格 用户的期望价 格 可接受价格 等 11 产品经济效益初步分析 产品经济效益初步分析 根据对产品市场 技术 生产能力 成本 价格等因素的分析 在财务部门的协助下 估计投资此项产品开发所能获得的经济效益 包括产品的毛利润率 净利润率 净资产回 报率 收回投资的时间等 12 投资风险及建议 投资风险及建议 给出投资此项产品开发的风险 包括市场风险 技术风险及其他可能的风险及对策 对是否投资此项产品开发作出建议 精品文档 产品研制规范产品研制规范 编写内容规范编写内容规范 产品研制规范 作为市场与开发的接口文档 主要从高层次来描述系统所要解决 的问题 描述用户需要怎样的产品或服务 并对实现需求目标所需采取的措施和计划进行 描述 可作为软硬件总体设计的依据 具体编写内容如下 1 1 范范围围 本规范规定了XX 产品型号 XX 产品名称 的功能需求 可信性需求 可生产性需求以及设计与开发验证方案 设计与开发确认方案 进度 成本估计 等方面的要求 本规范适用于XX 产品型号 XX 产品名称 的开发研制工作 2 2 引引用用标标准准 3 3 定定义义和和缩缩略略语语 本标准应用了以下缩略语 第一篇第一篇 功能需求功能需求 4 4 功功能能和和指指标标 5 5 功功能能排排序序及及权权数数表表 6 6 功功能能分分解解结结构构 精品文档 7 7 接接口口要要求求 第二篇第二篇软件需求软件需求 视情况单列视情况单列 8 8 软软件件需需求求 8 8 1 1 软软件件 功功能能需需求求 8 8 2 2 运运行行环环境境 硬件环境 软件环境 8 8 3 3 性性能能需需求求 数据存储要求 可可选选 时间特性 可可选选 8 8 4 4 接接口口 用户接口 精品文档 硬件接口 软件接口 8 8 5 5 可可靠靠性性需需求求 余量需求 故障处理 不允许发生的事件 安全和保密 8 8 6 6 其其他他需需求求 可选 9 9 软软件件数数据据需需求求 9 9 1 1 数数据据需需求求 静态数据 动态数据 数据约束 可可选选 9 9 1 1 数数据据采采集集 可选 精品文档 9 9 2 2 数数据据库库描描述述 第三篇第三篇可信性需求可信性需求 1 10 0 环环境境需需求求 1 11 1 可可靠靠性性需需求求 1 12 2 E EM MC C 需需求求 1 13 3 安安全全性性要要求求 1 14 4 测测试试性性要要求求 1 15 5 维维修修性性要要求求 第四篇第四篇可生产性需求可生产性需求 1 16 6 结结构构要要求求 1 17 7 工工艺艺要要求求 精品文档 1 18 8 外外观观要要求求 1 19 9 布布线线及及连连接接 第五篇第五篇标准化综合要求标准化综合要求 第六篇第六篇关键技术关键技术 2 20 0 关关键键技技术术薄薄弱弱环环节节 第第六六篇篇 设设计计与与开开发发进进度度 2 21 1 项项目目分分解解 2 22 2 完完成成时时间间 2 23 3 关关键键路路线线及及节节点点 第七篇第七篇 验证和确认验证和确认 精品文档 2 24 4 设设计计与与开开发发验验证证方方案案 为验证设计输出满足设计输入的要求 制订产品设计功能的验证方案 2 25 5 设设计计与与开开发发确确认认方方案案 第八篇第八篇 成本要求成本要求 2 26 6 成成本本要要求求 精品文档 软件需求说明书软件需求说明书 编写内容规范编写内容规范 对纯软件开发和比较大型软件开发 要求根据软件特点 独立于 产品研制规范 专门进行软件需求分析 从高层次来描述系统所要解决的问题 描述用户需要怎样的产品 或服务 并对实现需求目标所需采取的措施和计划进行描述 可作为软件总体设计的依据 具体编写内容如下 1 前言 前言 1 1 目的 阐明编写需求分析的目的 指明用户对象 系统分析员 开发人员 测试人员 1 2 项目背景 a 该软件系统与其他系统的关系 b 项目的开发单位及人员 1 3 参考资料 列举出相关参考资料 2 项目概述 项目概述 2 1 目标 叙述该项软件开发的意图 应用目标 作用范围 解释被开发软件与其他有关软件 之间的关系 如果所定义的产品是一个更大的系统的一个组成部分 则应说明本产品与该 系统中其他个组成部分之间的关系 为此可使用一张方框图来说明该系统的组成和本产品 同其他各部分的联系和接口 2 2 运行环境 2 2 1 硬件设备要求 宿主机 目标机 要描述软件系统所需的硬件设备的能力要求 如处 理器的数量 内存容量 存储媒体的数量 输入 输出设备的数量 通信网络结构 网络 的线路速度及通讯协议等 2 2 2 软件环境要求 要列出支持软件 包括要用到的操作系统 数据库系统 编译 或汇 编 程序 测试支持软件等 2 3 用户特性 列出本软件的最终使用者的特点 充分说明操作人员 维护人员的教育水平和技术 专长 以及本软件的预期使用频度 2 4 条件与限制 2 4 1 某些既成事实的限制 硬件 软件等 2 4 2 整个大环境的情况 2 4 3 某些规定的限制 精品文档 3 性能需求 性能需求 3 1 数据存储要求 确定软件的存储容量要求 如处理的记录数和处理数据的最大容量等 3 2 管理能力的要求 3 3 时间特性 如响应时间 更新处理时间 数据转换与传输时间 误码率 运行时间等 3 4 适应性 在操作方式 运行环境 与其他软件接口以及开发计划等发生变化时 应具有的适 应能力 4 功能需求 功能需求 4 1 功能划分 描述整个软件在职能上应做什么 应满足哪些功能要求 4 2 功能描述 详细描述每一条功能 用文字 图形 逻辑或数学方法描述 5 数据需求 数据需求 对数据进行描述时可把数据分为静态数据和动态数据 所谓静态数据 指在运行过程 中主要作为参考的数据 他们在很长的一段时间内不会变化 一般不随运行而改变 所谓 动态数据 包括所有在运行中要发生变化的数据以及在运行中要输入 输出的数据 5 1 静态数据 列出所有作为控制或参考用的静态数据元素 5 2 动态数据 列出动态输入数据元素 包括在常规运行中或联机操作中要改变的数据 5 3 数据约束 列出若要进一步扩充数据或更充分地使用数据 而对数据要求提出的限制 如文件 记录和数据元素的最大容量或最多个数 特别应强调在设计和开发中被确定为临界的那 些约束 5 4 数据库描述 说明为满足上述数据要求 数据库应满足的功能 性能 可靠性要求 6 数据采集 根据具体软件可选 数据采集 根据具体软件可选 6 1 要求和范围 6 1 1 输入源 说明数据来自操作员 还是其他分系统或输入装置 精品文档 6 1 2 接受者 应区分出如下种类 输入到系统 经处理后基本上无变化再输出的数据 输 入到系统 但不再输出的数据 由程序生成后输出的数据 6 1 3 临界值 指出数据元素的范围 如一个转折点 临界值等 6 1 4 量纲 对数值量 应规定数据元素的增量 度量单位 测量单位的零点和值域 对于 非数字量值 要用符号表示一些法定的值及他们之间的关系 6 1 5 换算因子 给出经模拟转换或数字转换处理的实测量的换算因子 6 1 6 数据更新频度 对同步数据 应给出输入 输出的更新频度 对异步数据 也要给出 频度平均值或变化的某种度量 6 2 数据采集和传递方式 详细描述采集过程 包括数据格式 传输媒体和输入输出时间特性 7 接口需求接口需求 7 1 用户接口 如屏幕格式 报表格式 菜单格式 输入输出时间等 7 2 硬件接口 说明该软件同硬件之间的配合关系等 7 3 软件接口 说明该软件同其他软件之间的接口 数据通信协议等 8 可靠性需求 可靠性需求 8 1 余量需求 在需求分析时 应给安全关键软件留有足够余量 这些余量包括 存储量 输入输出 通道的吞吐能力以及处理时间等 例如 对整个计算机系统而言 推荐的存储量 输入输 出通道的吞吐能力及处理时间余量不少于 20 8 3 故障处理要求 列出可能的软件 硬件故障以及对各项性能而言所产生的后果和对故障处理的要求 8 4 不允许发生的事件 明确列出所有在软件运行过程中绝对不允许发生的事件 如关键判别式决不允许误判 等 以作为设计约束 8 5 可靠性指标的验证 可选 对有可靠性指标的软件 在确定了软件的功能性需求后 应考虑该软件的可靠性指标 是否能达到以及是否能够验证 如果可靠性指标不能达到或者不能验证 那么 需求分析 人员应向上级主管部门汇报 以期得到其他的解决方法 如果软件的可靠性指标既能达到 又能验证 那么 需求分析人员应同用户密切配合 确定软件的功能剖面 并制定软件可 精品文档 靠性测试计划 9 其他需求 其他需求 如可使用性 可维护 可移植性 开发平台的需求等 精品文档 硬件总体设计方案硬件总体设计方案 编写内容规范编写内容规范 硬件总体设计方案 阐述系统硬件总体要求 指导硬件开发和测试开展工作 具 体编写内容如下 1 前言 前言 1 1 设计依据 列举出硬件的设计依据 包括 产品研制规范 等 1 2 设计目标 说明硬件设计应达到的目标 包括兼容性 可扩展性和可维护性等 1 3 基本原理 简要说明硬件设计的基本原理 1 4 相关标准 2 系统硬件总体构成 系统硬件总体构成 若是改进版 着重说明变化部分 2 1 系统总体框架 用图表形式描述系统总体框架 并简要说明各部分的联系 2 2 硬件功能方框图 以功能模块图给出硬件联系并简要说明划分理由 2 3 硬件单板联系图 以单板为模块给出系统联系图 简要说明与功能模块的对应关系 并简要说明单板划分 理由 2 4 系统硬件各组件结构排列图 给出系统各组件结构排列图 并给出排列的理由 3 硬件单板功能及特性描述 硬件单板功能及特性描述 若是改进版 着重说明变化部分 就每块单板按以下顺序说明 3 1 单板详细功能及方框图 3 2 单板的特性描述和指标说明 指明主要信号在单板的特性 单板各种指标的说明 如 CPU 处理速度要求 MIPS 通信系统的传输带宽 误码率 CPU 升级路径 功耗等 3 3 单板与系统的配合要求 指出各单板与系统的配合 如 时序配合 驱动能力 阻抗匹配等 3 4 单板主要器件推介 对单板用到的主要器件进行较为详细的介绍 并指出其用法要点 3 5 实现要求 对关键电路的实现进行要求 如某一部分须用 EPLD FPGA 实现 或用推荐电路等 精品文档 4 母板信号连接图 母板信号连接图 用图表列出母板的信号说明和接口的信号说明 即各单板的出线信号详细说明 5 配置说明 配置说明 给出系统硬件各种应用场合的配置说明 6 系统硬件关键技术说明 系统硬件关键技术说明 指明系统实现需注意的关键技术 难点和薄弱环节 并给出解决方案 指导开发人员 设计 7 结构与工艺 结构与工艺 应明确结构件主要外形尺寸 参照标准 热设计 电磁兼容设计 可达性设计 即便于 安装 维护的要求 及安全 防漏电损伤 机械损伤 设计等要求 对于需特殊处理的工 艺指出其要求 8 可信性设计要点说明 可信性设计要点说明 8 1 可信性管理项目 8 1 1 可信性计划 给出分阶段可信性计划 目标 通过准则 8 1 2 对转承方 供应方 外购 外协件 的控制办法 要求明确外购件的使用条件要求 可靠性参数 外协件的厂家质量水平 8 1 3 故障等级分类 要详细描述一级 二级故障现象 三四级中出现频率高的也应描述 8 2 可信性设计项目 8 2 1 任务可靠性模型 包括 可靠性框图和数学模型 要求 层次划分至单板 要考虑冗余部分的工作模式 8 2 2 可靠性分配 将系统可靠性指标 MTBF 分配到各组成部分 单板 以要求开发人员设计中能实 现 分配方法 相似法 比例法 专家评分法 8 2 3 元器件控制选择准则 参照公司 元器件优选手册 目前在编制中 以附录的方式列出本项目 产品 元 器件优选清单 包括本文档 3 4 推荐的单板主要器件 通用器件 还应包括导线 电缆 明确开发人员选用优选器件的最小比例或选用非优选器件的最大比例 8 2 4 明确设计应遵循的准则 8 2 4 1 降额设计 精品文档 根据 系统需求分析 中可靠性要求 确定本产品通用元器件降额等级与要求 具体 参见公司企业标准 元器件降额准则 对于特殊要求的器件可作补充说明 8 2 4 2 冗余设计 详述冗余部分的可靠性要求 工作方式 及其故障检测 备份转换机制的可靠性保证 措施 8 2 4 3 热设计 对产品进行热分析和热预计 对产品内部最高温升进行控制 确定系统散热方式 对结 构 单板提出热设计要求 8 2 4 4 ESD EMC 设计 1 明确接地措施 2 有静电要求的应加醒目的防静电标志 应明确设计 加工 运输 安装 使用过程中的 防静电要求 3 考虑系统 单板设计时的滤波措施 对电源进出端加滤波网络 对独立模块的电源加滤 波 等 4 指出那些信号需考虑屏蔽措施 CMOS 电路使用时所采用的防拴锁措施 8 2 4 5 耐环境设计 1 明确防振动 冲击措施 保证整机能满足有关要求 如运输要求 2 明确 三防 防潮 防盐雾 防霉菌 措施 保证整机满足工作环境要求 8 2 6 可测试性设计 根据测试要求和故障监测要求 进行机内测试设备 BITE 和外部测试设备 ETE 的权衡 确定机内测试设备的性能要求 8 2 6 1 确定系统的机内测试 BIT 的故障检测和故障隔离的要求 a 确定系统可能有的故障和使用 BIT 时的故障检测率 b 确定 BIT 的故障隔离要求 应使系统 BIT 对系统或设备进行初始检测并将故障隔 离到可替换单元 8 2 6 2 确定系统 BIT 的可靠性要求 机内测试设备可靠性一般要优于被测设备一个数量级 即 BIT 电路和装置的故障率不 得超过被测设备故障率的 10 8 2 6 3 初步确定各子系统 模块 的 BIT 根据 BIT 的故障检测隔离的要求和可靠性要求 初步确定各子系统 模块 的 BIT 并将系统的故障检测和隔离要求划分到各子系统 模块 中去 8 2 6 4 生产测试的要求 生产测试主要由自制测试设备和在线测试设备完成 自制测试设备主要是用来进行单 板功能测试和整机测试 而在线测试主要是发现单板上的元器件错误和元器件安装错误 精品文档 在总体方案设计中 应提出自制测试设备和在线测试的可测性要求 a 总体方案中确定的子系统 模块或单板中应有通讯接口 b 为子模块和单板所确定的软件和硬件接口应尽量统一和标准 c 应尽量使用有自检和自环等自测试功能的元器件 d 在总体方案中为子模块和单板的自测试功能子程序分配或预留一定的命令编码 e 为在线测试可行和方便 单板上的元器件 特别是 SMT 器件 应留有测试点 或者采用具有边界扫描测试 BST 功能的 IC 8 2 6 5 测试点的选定 确定一些用于系统 单板或模块故障检测 故障隔离和原位调整与校准的测试点 以 便于开发调试 生产线测试和维护中测试设备的接入 进行定量测试 性能测试和参数调 整及校准 设备测试点的选用按以下要求 a 应能通过选择的测试点接入外部设备来控制设备的运行和检测设备的运行状态 b 选用测试点应能方便地通过设备插头或测试插头连接到测试设备上 c 测试点应具有一定的安全性 测试点必须得到保护 以免外部非正常信号 如高 电压等 接入影响设备工作或损坏设备 d 不同类型的测试点应相互隔离 如 高电压大电流的测试点和低电平信号的测试 点要隔离 模拟电路和数字电路的测试点应分开等 8 2 7 其它可信性设计准则 视产品特点 明确其它应采取的可信性设计准则 如安全设计 防错设计 标记设 计等 9 计划与安排 计划与安排 9 1 资源要求 说明硬件开发 测试所需要的人员 开发工具或软件 测试仪器或仪表 每一资源要求 的日程表及持续时间等 9 2 组织计划 描述硬件实施建议的组织结构 9 3 阶段性开发进度表 制定指导性的阶段开发进度表 对每一阶段的内容详细描述 须明确系统 开发 测 试部项目人员各自工作阶段目标 里程碑 相互配合要求及检查点 精品文档 软件概要设计说明书软件概要设计说明书 编写内容规范编写内容规范 面向过程 面向过程 软件总体设计 阐述系统软件总体要求 指导软件开发和测试开展工作 根据软 件类型分为面向过程和面向对象进行叙述 具体编写内容如下 1前言前言 1 1 设计依据 列举本软件的设计依据 包括 软件需求分析 各种标准规范等 1 2 设计目标 说明本软件设计应达到的目标 包括扩充性 移植性 兼容性等 1 3 设计原则 说明本软件设计应遵循的原则 2总体结构设计总体结构设计 2 1 总体结构设计描述 先按层次描述软件的总体结构 概述每层应完成的功能 然后用软件总体结构层次图 形象地描述软件的总体结构 2 2 各层结构设计描述 详细描述该层软件的结构及其完成的功能 用软件结构层次图来描述该层软件的结构 3 功能模块设计 若是改进版 着重说明变化部分 功能模块设计 若是改进版 着重说明变化部分 3 1 功能模块的划分 确定整个软件系统中每个功能由哪些模块组成 用模块IPO图来描述这些模块之间的 控制关系 3 2 各功能模块设计描述 详细描述该功能模块的功能 与其它模块之间的相互关系 该模块的接口说明 输入 输出 4 数据结构设计 数据结构设计 4 1 数据划分 确定数据处理的原则 即哪些数据由文件系统存储处理 哪些数据由数据库系统存储 处理 4 2 文件系统的数据结构设计 可选 确定数据在文件系统中的存储格式 存储容量 存取方法等 4 3 数据库系统的数据结构设计 可选 确定数据库系统的类型 关系数据库 层次数据库等 数据库的模式 子模式结构定 义 定义各数据库的结构及相互之间的关系 4 4 数据可靠性设计 精品文档 确定数据的完整性 安全性 冗余性策略 5 软件要素设计 软件要素设计 5 1 软件开发系统 5 1 1 明确具体软件开发系统 操作系统 数据库系统 界面开发工具等 的配置 资源要 求和限制 描述软件开发系统所提供的技术开发要素 如任务 线程 消息队列 事件 信号量 软件异步中断等 5 1 2 模块命名规则 编程语言及注释规则 5 2 各软件要素说明 软件要素是模块功能实现的载体 详细说明实现模块功能所需的各个要素 6 可靠性设计可靠性设计 6 1 设计约束条件 确定限制设计实现的某些约束条件 6 2 可靠性模型 明确本软件系统所采用的可靠性模型 6 3 可靠性指标 说明本设计应能达到的可靠性要求 6 4 可测试性 对各模块可测试性提出要求 7 软件处理流程软件处理流程 7 1 总体处理过程及数据流图 说明软件的总体处理过程 并用数据流图表示该处理过程 7 2 模块处理过程及数据流图 说明各模块的处理过程 并用数据流图表示该处理过程 8 软件计划与进度安排 软件计划与进度安排 8 1 环境资源 说明软件开发所需要的人 硬件和软件 每种资源要从资源的描述 对资源要求的日 程表以及对资源应用的持续时间三方面说明 8 2 成本估算 从所需的资源数量和时间来初步估算软件的开发成本 8 3 开发进度表 制定指导性的阶段开发进度 包括总体设计在内 精品文档 软件概要设计说明书软件概要设计说明书 编写规范编写规范 面向对象 面向对象 1 前言 前言 1 1 设计依据 列举本软件的设计依据 包括 软件需求分析 各种标准规范等 1 2 设计目标 说明本软件设计应达到的目标 包括扩充性 移植性 兼容性等 1 3 设计原则 说明本软件设计应遵循的原则 2系统设计系统设计 2 1 系统层次结构设计描述 系统层次设计要完成系统总体结构在水平方向的层次划分和在垂直方向的条块划分 从水平方向来看 系统的层次反映了系统的各个不同的抽象级别 从垂直方向来看 系统 的条块代表了系统的各个对外服务 用结构层次图形象地描述软件的总体结构 并概述每 层应完成的功能 即提供的服务 2 1 1 详细描述各层软件的结构及其完成的功能 2 1 2 2 2 系统数据存储设计描述 系统数据存储方式的设计要确定系统中各种数据的存储方式 包括内存数据结构 文 件 数据库等 2 3 系统资源访问设计描述 系统资源访问设计要确定系统中需要使用的各种类型的资源 并且要确定访问这些资 源的控制机制和安全性机制 2 4 网络与分布设计描述 网络与分布设计要确定系统在支撑网络结构上是如何进行分布处理的 设计中要对网 络流量 分布单元的处理能力和系统的总体效率作综合的考虑 2 5 并发性设计描述 并发性设计要确定系统中的并发单元 确定各并发单元的实现方式和并发控制策略 设计时要考虑并发可能产生的效果 2 6 对象互操作方式设计描述 对象互操作方式设计要确定对象之间的消息传递方式 如过程驱动 事件驱动和并发 驱动等 在分布系统环境下 还要确定远程对象的交互方式 2 7 其它设计描述 精品文档 3 对象分析与设计 对象分析与设计 3 1 基于图形的对象描述 Yourdon 提出的 OOA 方法包括五个步骤 1 确定对象 2 确定结构 3 定义主题 4 定义属性和实例联系 5 定义操作和消息联系 通过上述五个步骤得到结构化的图文档 所生成的 OOA 模型自顶向下包括五个层次 主题层 主题是一组类与对象 类与对象层 结构层 一般化 特殊化结构 类间的继承关系 全体 部分关系 一个对 象怎样由其它对象组成 属性层 属性 与实例有关的信息 服务层 服务 类上的操作 其具体操作方法和符号表示见相关书籍 可参见 软件工程 杨文龙等编著 电子 工业出版社 1997 年 11 月 3 2 基于文本的对象描述 对于所有的对象建议采用下面的提纲进行描述 1 对象名 2 父类对象名 3 3 属性描述 2 1 属性名 2 2 属性内容描述 2 3 属性数据类型 结构 3 4 对象的外部输入 3 5 对象的外部输出 3 6 操作描述 3 6 1 操作名 3 6 2 操作接口描述 3 6 3 操作过程描述 3 6 4 执行结果 3 6 5 约束条件和极限值 3 6 7 实例联系 精品文档 3 6 8 消息联系 3 7 事件 响应对象交互 EROI 图 EROI 图是标识和描述对象相互通信的有效工具 EROI 极其有助于标识和描述对象之间的相互通信和协作关系 对每个事件 EROI 图表 明了由哪个对象来识别事件的发生 产生什么消息 其它那些对象接受这些消息 并产生 什么响应 EROI 图是事件 响应模型和 OOA 模型的集成 对于具体化系统的动态行为 它 是一个非常有用的工具 可以对于每个系统事件 给出其 EROI 图 并附上系统如何识别事 件发生 以及如何生成合适的响应的文本描述 EROI 图详细规格可参阅相应资料 4软件要素设计软件要素设计 4 1 软件开发系统 4 1 1 明确具体软件开发系统 操作系统 数据库系统 界面开发工具等 的配置 资源要 求和限制 描述软件开发系统所提供的技术开发要素 如任务 线程 消息队列 事件 信号量 软件异步中断等 4 1 2 模块命名规则 编程语言及注释规则 4 2 各软件要素说明 软件要素是模块功能实现的载体 详细说明实现模块功能所需的各个要素 5可靠性设计可靠性设计 5 1 设计约束条件 确定限制设计实现的某些约束条件 5 2 可靠性模型 明确本软件系统所采用的可靠性模型 5 3 可靠性指标 说明本设计应能达到的可靠性要求 5 4 可测试性 对各模块可测试性提出要求 6 软件计划与进度安排 软件计划与进度安排 6 1 环境资源 说明软件开发所需要的人 硬件和软件 每种资源要从资源的描述 对资源要求的日 程表以及对资源应用的持续时间三方面说明 6 2 成本估算 从所需的资源数量和时间来初步估算软件的开发成本 精品文档 6 3 开发进度表 制定指导性的阶段开发进度 包括总体设计在内 精品文档 系统调试方案系统调试方案 编写内容规范编写内容规范 系统调试方案 包括硬件和软件的系统调试方案 用于指导开发人员系统调试工作 具体编写内容如下 1 概述 概述 1 1 简述系统的主要构成及基本原理 1 2 简述系统调试基本思路和方法 2 调试子任务的划分 调试子任务的划分 按时间循序或功能相关性将几个模块或单板组合成一个子任务 要简要说明如此划分的 理由 若有可能确定子任务负责人 3 调试方法 调试方法 按子任务划分结果 就每个调试子任务分别叙述以下内容 3 1 按功能或特性描述调试的基本原理和方法 3 2 按功能或特性描述调试的循序和步骤 3 3 给出调试要点和注意事项 3 4 若需软硬件配合 给出配合要求 2 资源与计划资源与计划 4 1 就每个调试子任务分别给出所需具备的调试环境或资源配置 如 调试母板 单板或 模块所需达到的功能或特性要求 仪器 仪表 软硬件开发工具等 4 2 按照系统总体进度要求细化各调试子任务进度和目标要求 精品文档 单板设计规范单板设计规范 编写内容规范编写内容规范 单板设计规范 是开发第一阶段所出文档 开发人员根据系统部 硬件总体设计 和 产品研制规范 中对单板的要求 提出具体的实现方法 资源和进度安排 具体编写 内容如下 1 概述概述 简述单板在系统中所处的位置 所需完成的功能 特性和指标 2 实现方案实现方案 2 1 给出二种以上可供选择的实现方案及几种方案的优缺点比较 若仅提供一种方案 陈 述仅有此唯一方案的理由 2 2 给出方案中主要电路及元器件选定理由 3 原理框图原理框图 分别就每种方案以功能块或主要芯片为单元 画出各单元之间的逻辑连接关系 包括支撑整个电路的主要信号线或引出线 4 基本原理基本原理 详细介绍各单元电路的基本工作原理 及整个电路的工作过程 若有必要提供相 应的时序图 逻辑图 信号关系 输入输出关系等 5 单板与系统接口说明单板与系统接口说明 5 1 引出线信号表及符号定义 1 内容包括印制板插头或插座 与外部连接的各个通信电缆连接或插头座等的引出线 信号表 以及各个引出线的符号定义 2 以表格形式给出引出线信号名称 并在表格后面对引出线信号定义作出说明 表格 中的引出线信号名称应与原理图中完全相同 5 2 引出信号线电特性要求 对于关键或主要信号线进行电特性描述 如 信号电平 信号频率 驱动能力 输入 输出阻抗等 5 3 引出信号线时序与系统配合要求 5 4 软件接口说明 应基本能使软件人员能根据 软件接口说明 进行编程 说明包括 地址空间分配 包括 ROM 地址 RAM 地址 I O 地址 各可编程芯片的接口地址和各功能的软件操作步骤 各可编程芯片的方式控制字 状态字 命令字等的格式说明 6 6 电电源源和和接接地地 6 1 电源 精品文档 说明提供给单板的电源的波动范围 每种电源的入口地址 对单板的功耗的要 求 6 2 接地 说明提供给单元 单板的接地线的种类 接地入口和对地线相应的特别要求 7 7 关关键键技技术术 说明单元 单板必须采用的一些关键技术 并用框图画出所用的器件和外围电 路 相应的信号要求等 对单元 单板规定必须采用的器件或接口技术 保护电路的要求 用原理图或 框图画出相应的电路 以及技术要求 对不能完全确定的关键技术和指标分配 给出推荐的框图和应用 8 8 可可信信性性设设计计说说明明 8 1 单板的任务可靠性模型 包括任务可靠性框图和数学模型 8 2 可靠性指标 根据单板元器件清单和可靠性模型通过可靠性预计得到的近似可靠性指标 应与 硬件 总体设计 中分配到单板的可靠性指标相一致 8 3 可信性设计准则的遵循 8 3 1 降额设计 说明元器件是否按 硬件总体设计 的要求进行了降额 没有降额的应明确理由 8 3 2 冗余设计 若有必要 说明本板采用冗余设计的方案 8 3 3 热设计 说明为达到 硬件总体设计 热设计中的要求 本板所需采取的措施 8 3 4 ESD EMC 设计 说明采取 ESD EMC 设计的组成部分 具体措施 8 3 5 耐环境设计 说明所采取的防振动 冲击 环境污染措施 8 3 6 可测试性设计 说明落实 硬件总体设计 设计中可测试性要求的情况 8 3 7 其它可信性设计 说明所需采取的其它可信性设计技术 如安全 防错等 精品文档 9 9 工工艺艺需需求求 图示说明单板的外形尺寸 测试孔 指示灯位置及定义等 对单板的可生产性设计 可达性等工艺要求 1 10 0 资资源源与与进进度度 10 1 给出单板设计与调试所需资源 如 调试母板 为调试所需的配合电路或单板 仪器 仪表 软硬件开发工具等 10 2 按照系统总体进度要求细化出本板进度和目标要求 精品文档 软件模块设计方案软件模块设计方案 编写内容规范编写内容规范 软件模块设计方案 是软件模块开发第一阶段所出文档 软件开发人员根据系统部 软件总体设计 和 软件需求说明书 中对软件模块的要求 提出具体的实现方法 资 源和进度安排 具体编写内容如下 1 概述概述 1 1 背景 1 2 定义 1 3 参考资料 2 模块系统的组织结构 模块系统的组织结构 2 1 该模块的地位和作用 该模块与上下级模块 同级相关模块的关系 该模块的作用 2 2 该模块的组成 说明组成该模块的子模块 3 模块设计说明模块设计说明 3 1 模块描述 3 2 功能 3 3 性能 3 4 输入项 3 5 输出项 3 6 算法 3 7 流程逻辑 3 8 接口 包括与硬件的接口 3 9 存储分配 3 10 注释设计 3 11 限制条件 3 12 尚未解决的问题 4 可靠性设计说明 可靠性设计说明 根据 软件总体设计 中对可靠性的要求 具体落实本模块的可靠性 4 资源与进度资源与进度 4 1 说明本模块所需要的硬件环境 软件工具 其他软件的配合要求 5 2 按照软件系统总体进度要求细化出本模块进度和目标要求 精品文档 自测方案自测方案 编写内容规范编写内容规范 自测方案 包括 单板自测方案 模块自测方案 和 系统自测方案 主要描述 开发人员自测的总体思路 简要叙述自测方法 资源和进度安排 此工作可在测试人员的 协助下完成 具体编写内容如下 1 概述概述 1 1 自测任务描述 简述单板 模块名称 版本号 功能特性 与其它单板 模块的联系 1 2 自测环境 为达到自测目的所需要提供的软硬件环境 1 3 测试的总体思路 2 自测内容及测试通过准则自测内容及测试通过准则 分功能或特性对自测内容一一描述 并确定测试通过准则 3 测试方法测试方法 描述测试方法 测试用例或测试手段 用软件测试工具进行测试的要写出测试工具名 称及其提供的功能 4 测试资源与进度安排测试资源与进度安排 5 1 测试资源 为达到自测目的所需要提供的软硬件环境 测试仪表或工具 5 2 预期的时间进度安排 根据总体进度要求确定自测进度和目标要求 要注意测试时间上的安排是否合理以及 是否需要相关人员的配合 精品文档 自测报告自测报告 编写内容规范编写内容规范 自测报告 包括 单板自测报告 模块自测报告 和 系统自测报告 主要描述 开发人员提交测试前的自测结果 此工作可在测试人员的协助下完成 具体编写内容如下 1 概述概述 1 1 自测项目名称 版本号 测试人 1 2 测试环境 软硬件的配置 版本 组网和其他需要说明的情况 2 测试记录及分析 测试记录及分析 2 1 详细记录自测中发现的问题以及是如何改正的 2 2 测试过程中是否全部按照 自测方案 中所给定的测试用例来进行测试 是否有遗漏 2 3 测试结论 根据 自测方案 中测试通过准则的要求给出是否通过自测的结论 3 测试总结 测试总结 总结已解决问题的方法和经验 分析自测活动中一些失败的经验和教训 为今后的系 统设计 开发和测试工作提出建议 精品文档 单板设计说明单板设计说明 编写内容规范编写内容规范 单板设计说明 是单板开发调试阶段基本完成后所出文档 详细说明单板开发调试 阶段所做的工作 具体编写内容如下 1 设计输入 设计输入 内容包括设计目标 功能要求 实现方案 主要电路及元器件选定理由 与同类产 品比较有哪些优点和不足等 2 原理框图 原理框图 以功能块或主要芯片为单元 画出各单元之间的逻辑连接关系 包括支撑整个电路 的主要信号线或引出线 3 基本原理 基本原理 详细介绍各单元电路的基本工作原理 及整个电路的工作过程 包括相应的时序图 逻辑图 信号关系 输入输出关系等 4 软件接口说明 软件接口说明 说明主要包括 地址空间分配 包括 ROM 地址 RAM 地址 I O 地址 各可编程芯片的接口地址和各功能的软件操作步骤 各可编程芯片的方式控制字 状态字 命令字等的格式说明 5 主要器件介绍 主要器件介绍 内容包括主要 专用及特殊器件 包括 LATTICE FPGA 等可编程器件 的特点 功能 引脚说明 时序图等 采用 LATTICE FPGA 等可编程器件 底层电路由编程 工程师编写的电路为准 但必须符合电路设计人员的设计思想和功能 时序要求 由 电路设计工程师与编程工程师相互核实认可 最终由编程人员编写 可编程器件设计 与 单板详细设计 两者合订成册 但标题封面各自分开 6 引出线信号表及符号定义 引出线信号表及符号定义 内容包括印制板插头或插座 与外部连接的各个通信电缆连接或插头座等的引出 线信号表 以及各个引出线的符号定义 以表格形式给出引出线信号名称 并在表格后面对引出线信号定义作出说明 表 格中的引出线信号名称应与原理图中完全相同 7 可信性设计说明 可信性设计说明 7 1 单板的任务可靠性模型 包括任务可靠性框图和数学模型 7 2 可靠性指标 根据单板元器件清单和可靠性模型通过可靠性预计得到的近似可靠性指标应与 硬件 精品文档 总体设计 中分配到单板的可靠性指标相一致 7 3 元器件选用 详细说明所用元器件的可靠性参数 包括质量等级 及占 产品器件优选清单 的比 例构成 可与 材料单 本文档第 10 条 合二为一 7 4 可信性设计准则的遵循 7 4 1 降额设计 说明元器件是否按总体方案的要求进行了降额 没有降额的应明确理由 7 4 2 容差设计 对于以模拟电路为主的功能模块 必须以附录形式给出容差设计结果 建议使 用 田口设计 方法 参见可靠性园地中有关介绍 7 4 3 冗余设计 详细说明所采用的冗余设计对提高可靠性的效果 7 4 4 热设计 说明所采用的热设计的效果 如温度分布情况 器件最高壳温 7 4 5 ESD EMC 设计 说明采取 ESD EMC 设计的组成部分 具体措施与效果 7 4 6 耐环境设计 说明所采取的防振动 冲击 环境污染措施 7 4 7 可测试性设计 说明设计中遵循 可测试性设计规范 的情况 7 4 8 其它可信性设计 说明所采取的其它可信性设计技术 如安全 联锁 防错等 8 电源与接地电源与接地 说明单板的电源要求和地线的安排 9 9 成成本本预预计计 根据使用的元器件和数量列表预计单板的硬件成本 10 材料单 材料单 按标准格式列出 参 WP5 12 除单板的料单外 产品还应有一份 装配料单 以便供应部采购单板外的其 他元器件 装配料单 的格式同单板料单 精品文档 精品文档 软件模块设计说明软件模块设计说明 编写内容规范编写内容规范 软件模块设计说明 是软件模块开发调试阶段基本完成后所出文档 详细说明模块 开发调试阶段所做的工作 具体编写内容如下 1 引言引言 1 1 范围 本文档包含的内容及有关文档的说明 1 2 参考资料 与本文档相关的文档以及参考书籍 1 3 术语 缩略词 可略过 2 概述概述 2 1 该模块的地位和作用 该模块与上下级模块 同级相关模块的关系 该模块的作用 2 2 该模块完成的功能 详细说明该模块完成软件系统中相应的功能 2 3 该模块的组成 说明组成该模块的子模块 3 数据说明 数据说明 3 1 常量说明 3 2 变量说明 全局变量和重要的局部变量说明 3 3 数据类型说明 包括类型说明 对象类的层次结构说明等 3 4 数据库说明 结构定义 数据量等 视各模块的具体情况可选 3 5 其他说明 需要的大量内存说明 重要算法说明 通信协议格式说明 任务和消息队 列说明 进程和线程说明等 视各模块的具体情况可选 4 模块说明模块说明 不包含子模块则选用不包含子模块则选用 4 1 原型定义 4 2 输入 输出和错误代码说明 输出包括参数输出 消息队列和事件等 4 3 调用关系 4 4 流程图 5 模块结构图 模块结构图 包含子模块则选用包含子模块则选用 以层次图的形式说明模块和子模块的关系 6 需说明的其他事项 视各模块的具体情况可选 需说明的其他事项 视各模块的具体情况可选 6 1 以相对路径给出源文件目录组织 6 2 以表格形式列出各文件包含的子模块 精品文档 6 3 其他 7 子模块说明 子模块说明 包含子模块则选用包含子模块则选用 7 X 子模块 X 7 X 1原型定义 7 X 2输入 输出和错误代码说明 输出包括参数输出 消息队列和事件等 7 X 3调用关系 7 X 4功能 7 X 5流程图 注 子模块大小为 200 行 精品文档 可编程器件设计说明可编程器件设计说明 编写内容规范编写内容规范 1 电路说明 包括功能模块说明 2 详细完整的电原理图 按 A3 REDUCED A4 打印 3 采用的可编程器件的名称 封装形式 4 清晰完整的出脚说明 5 各可编程文件具体文件名 存档磁媒体存放路径 备份文件磁媒体存放路