详细设计说明书模板.docx

<项目名称>北京锐安科技有限公司 <项目名称> 北京锐安科技有限公司 Ver201403第 Ver201403 第 PAGE 10 页 共 14 页 文档作者： 文档呈送： 文档抄送： XX 项目 详细设计说明书 <VX.Y> 参与评审： 编 写： 审 核： 批 准： 变更记录 版本号 版本号 变化状态 修改点说明 变更人 存放位置 审批人 审批日期 *变化状态：C――创建，A——增加，M——修改，D——删除 修改点说明：对变化状态进行简单解释，如增加了某项功能，修改了某个模块等信息。不允许出现“根据评审意见修改等字样” 注：当文档未评审通过前版本号标识规则为 V0.X ,第一次评审通过后，版本号直接升级为 V1.0，之后变更按照 V1.X 升级。 目 录 前提和约束 4 编写目的 4 预期读者和阅读建议 4 定义、缩写词、略语 4 参考资料 5 前提和约束 6 前提条件 6 限制和约束 6 综合描述 6 系统目标 6 系统需求 6 系统概述 7 程序结构说明 7 源程序及编译链接组装说明 7 系统详细设计 7 XXX 子系统名称 8 XXX 包名称 9 XXX 子系统名称 2 10 用户界面详细设计（可裁剪） 10 界面结构 11 界面结构或菜单结构 11 用户界面图（如无此需要，可省略） 11 界面处理流程及界面约束描述（如无此需要，可省略）错误!未定义书签。 界面或模块名 1. 错误!未定义书签。 处理流程 错误!未定义书签。 界面约束与事件约束 错误!未定义书签。 触发方式 12 界面或模块名 2. 错误!未定义书签。 尚未解决的问题 13 资源对象说明 13 文档简介 [说明] 本部分要描述文档的目的，帮助读者对本文档建立基本印象，并为阅读后续内容扫清障。蓝色字体部分是文档的说明，请各位同事在完成文档撰写后删除该部分。 编写目的 [说明] 本部分主要阐述文档目的，而非项目目的。否则造成同一项目多个文档之间的内容重复， 不利于文档维护。 预期读者和阅读建议 [说明] 指定需要认真阅读此文档的人员。本小节应指明文档针对的读者对象，最好列出各种读者角色，并说明每种读者角色应该重点阅读的章节。 指明文档组织方式，简要描述各文档各部分关注的内容和解决的问题。 定义、缩写词、略语 [说明] 序号术语 序号 术语/缩略语 说明/定义 英文全称 中文译名 1 2 3 ... 参考资料 [说明] 作者文献名称出版单位（或归属单位） 作者 文献名称 出版单位（或归属单位） 版本或日期 前提和约束 前提条件 [说明] 类别文件名称主要依据章节及内容 类别 文件名称 主要依据章节及内容 是否完 全依据 需求 是 架构 是 概要设计 是 其 他 前 提条件 是 特殊情况说明： 限制和约束 [说明] 阐述应遵循的重要限制和约束，包括技术条件、软硬件条件、功能、性能目标约束等。 综合描述 系统目标 [说明] 系统最终要解决的实际问题或要达到的用户要求，系统如何能够做到客户满意。 系统需求 [说明] 系统由上游文档规定的需求的简要说明。说明本系统，本文档涵盖的需求及功能实现部分。 系统概述 [说明] 简述系统功能，映射详细设计的基础轮廓。用系统结构图表示系统内的包和主要类的名称、标识符和它们之间的层次结构关系，可以以系统体系结构划分，也可以由类类别划分 (边界类、控制类、助手类、实体类、数据类)，甚至可以由功能结构划分。 程序结构说明 [说明] 结合上游文件中的逻辑视图，描述最终的程序划分、结构图及功能与调用关系简要说 明、程序种类说明。本节为以下详细设计的简要索引，为系统程序的上层结构体系描述。详细设计时可能得不到精确的最终程序文件名列表，但是应当尽量完整说明其种类和主要文件内容。建议使用UML 图配合文字说明。 源程序及编译链接组装说明 [说明] 结合上游文件中的物理视图，本处为源程序和前一节的最终程序如函数库、可执行程序、资源文件等的对照表，以及从源程序文件转化成这些最终文件的具体过程（编译、链接、组 装）描述。在详细设计时可能得不到精确的源程序文件名，但是应当尽量完整说明其种类和主要文件内容。如果不同的文件具有不同的编译链接组装方式，则应在此处分别描述清 楚。在此处应明确分出各级编译单元，即哪些文件需要一起编译生成一个或一组编译后的 文件。编译单元文件可以是最终文件也可以是源程序和最终文件之间的中间文件。建议使用UML 图配合文字说明。 系统详细设计 [说明] 系统详细设计应当以 3.4 节程序结构说明节内容为索引，而不是 3.5 节源程序及编译链接组装说明，换句话说，应当以最终的物理功能实现（逻辑视图）为主线索，源程序的结构（物理视图）作为辅线索，结合