软件详细设计文档模板汇总.docxVIP

研发生产中心 文档编号 版本 A1 项目名称 Xx系统 项目来源 QR-RD-022(Ver1.2) Xxx软件 概要设计方案 （内部资料请勿外传） 期:期:期:期: 期: 期: 期: 期: XX公司 版权所有不得复制 文档变更记录 序号 变更（+/-）说明 作者 版本号 日期 批准 1 2 141530 14 15 30 141530 14 15 30 目录 1. 引言 1.1 编写目的和范围 1.2 术语表 1.3 参考资料 2. 需求 总体描述 功能 性能分析 2.3.1 精度 2.3.2 时间特性 2.3.3 灵活性 2.3.4 可靠性，可维护性，可操作性、防呆性 3. 环境 设备环境 软件环境 接口 保密与安全 3.4.1 说明 3.4.2 设计 3.4.3 数据传输部分 3.4.4 IP 过滤分部 4. 业务功能设计 运行过程 逻辑流程 功能模块 数据流向 4.4.1 输入 4.4.2 输出 通信协议 2.1 2.2 2.3 3.1 3.2 3.3 3.4 4.1 4.2 4.3 4.4 4.5 5. 数据库设计 6. 系统出错处理 5 8 8 8 10 10 10 10 11 11 11 11 11 11 11 11 13 14 18 29 引言 1.1编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑， 包括程序描述、输入/输出、 算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、 软件开发人员、软件测试人员和项目评审人员。 1.2术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号 术语或缩略语 说明性定义 1 PM P roject Ma nager, 项目经理 2 1.3参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括: a.需求说明书、架构设计说明书等; b本项目的其他已发表的文件; C.引用文件、资料、软件开发标准等。 资料名称 作者 文件编号、版本 资料存放地点 需求 概述系统的需求，指出有关的变更和增删 总体描述 包括数据文件名称及其所在目录，功能说明，具体常量说明等。 概括说明和图示系统主要部分之间的内部关系，使本文之外的内容有一个引用的线索， 需要整个系统的结构框图（硬件、软件） ，便于了解整个系统的功能，界面结构，功能模块 入数据库、通信等。 本软件作为老炼台的主要操作和信息显示界面， 提供设备更好的易用性和功 能灵活性，通过对组合老炼的自动化管理控制提高组合的批产效率。 上位机软件与老炼台之间的接口采用 422 接口，采用私有格式的数据交换通 信协议，协议内容主要包括设置和查询两类。 本软件是老炼试验台专用软件，老练完成生成动态的老练报表电子表格文 件。 老炼台（包含本软件） 的最终用户是所装调部工人， 要求操作界面简单易用， 流程清晰，相关内容命名统一规范。要求软件具有一定范围的灵活性和适应性， 以适用可能发生的用户生产流程改变， 软件在一般情况使用时应该不需要特别的 维护。 项目对时间进度的要求苛刻， 建议在软件架构设计时尽量熟悉老炼试验过程 的目的和特点， 使得架构具有一定的适应性和灵活性， 可以先完成核心架构和基 本功能，满足进度要求，后期再进行必要的改进和完善。 软件功能 本章说明本程序系统中使用的全局数据常量、变量和数据结构。 定性且定量地描述系统总体功能， 并说明这些功能是如何满足功能需求的， 这里应与软 件需求规格说明中所述的功能相一致，提供功能列表，每个需求分解出能支撑需求的功能列 表; 功能描述应包括: 1），数据处理，如何处理 2），界面显示，如何显示 3），通信功能，如何通信 由上位机软件设置门限极限参数包括电压、电流、时间，发送加电、断电指 令控制老炼，到达指定次数后完成老炼（自动断电并报告），老炼期间可人工终 止。对同时老炼的8套组合可以独立控制，也可以统一操作，方便用户使用。开 始老炼后上位机定时向下位机发送查询指令,下位机返回测量数据，在查询指令 始老炼后上位机定时向下位机发送查询指令, 下位机返回测量数据，在查询指令 等待管理人发送后超出等待返回时间，上位停止所有操作流程终端上位机程序, 员进行处理。数据为每路电压、电流测量值、老练时间，如果数值连续多次超出 范围则判为故障，自动断电并报告故障。由下位机判断电压、电流、老练时间门 限值，超出范围断开些路供电并声光报警。 同时记录当前出错的数据及相应的状 态。可以供上位机查询显示记录。 等待管理人 8行）。 8行）。 可以通过产品识别号查询并打印完整老炼记录,记