详细设计说明书_模板.docx
《详细设计说明书_模板.docx》由会员分享,可在线阅读,更多相关《详细设计说明书_模板.docx(12页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、详细设计说明书_模板 文档作者: 文档呈送: 文档抄送: XX项目 详细设计说明书 编写: 审核: 批准: 参与评审: 变更记录 版本号变化状态修改点说明变更人存放位置审批人审批日期 *变化状态:C创建,A增加,M修改,D删除 修改点说明:对变化状态进行简单解释,如增加了某项功能,修改了某个模块等信息。不允许出现“根据评审意见修改等字样” 注:当文档未评审通过前版本号标识规则为V0.X ,第一次评审通过后,版本号直接升级为V1.0,之后变更按照V1.X升级。 目录 1前提和约束 (4) 编写目的 (4) 预期读者和阅读建议 (4) 定义、缩写词、略语 (4) 参考资料 (5) 2前提和约束 (
2、6) 前提条件 (6) 限制和约束 (6) 3综合描述 (6) 3.1系统目标 (6) 3.2系统需求 (6) 3.3系统概述 (7) 3.4程序结构说明 (7) 3.5源程序及编译链接组装说明 (7) 4系统详细设计 (7) 4.1XXX子系统名称 (8) 4.1.1XXX包名称 (9) 4.2XXX子系统名称2 (10) 5用户界面详细设计(可裁剪) (10) 5.1界面结构 (11) 5.1.1界面结构或菜单结构 (11) 5.1.2用户界面图(如无此需要,可省略) (11) 5.2界面处理流程及界面约束描述(如无此需要,可省略)错误!未定义 书签。 5.2.1界面或模块名1. 错误!未
3、定义书签。 5.2.2处理流程. 错误!未定义书签。 5.2.3界面约束与事件约束. 错误!未定义书签。 5.2.4触发方式 (12) 5.2.5界面或模块名2. 错误!未定义书签。6尚未解决的问题 (13) 7资源对象说明 (13) 1文档简介 说明 本部分要描述文档的目的,帮助读者对本文档建立基本印象,并为阅读后续内容扫清障。蓝色字体部分是文档的说明,请各位同事在完成文档撰写后删除该部分。 编写目的 说明 本部分主要阐述文档目的,而非项目目的。否则造成同一项目多个文档之间的内容重复,不利于文档维护。 预期读者和阅读建议 说明 指定需要认真阅读此文档的人员。本小节应指明文档针对的读者对象,最
4、好列出各种读者角色,并说明每种读者角色应该重点阅读的章节。 指明文档组织方式,简要描述各文档各部分关注的内容和解决的问题。 定义、缩写词、略语 说明 按字母或拼音顺序列出所有的定义和缩略语,以便读者可以正确地理解架构设计说明书,包括词头和缩写。注意:只需要列出对理解本文有用的术语。 序号术语/缩略语说明/定义英文全称中文译名 1 2 3 . 参考资料 说明 列举编写架构设计说明书时所参考的资料或其它来源。包括但不限于:用户界面风格指导、合同、标准、系统需求规格说明书、用户需求、相关产品的产品需求规格说明书等。可根据项目的实际情况选择参考资料的范围,但至少应包括用户需求说明书和需求分析说明书。
5、作者文献名称出版单位(或归属单位)版本或日期 2前提和约束 前提条件 说明 对详细设计工作依赖的上游文档做说明。可使用表格或文字进行简要说明,没有的项目写无。 类别文件名称主要依据章节及内容是否完 全依据需求是 架构是 概要设计是 是 其他前提 条件 限制和约束 说明 阐述应遵循的重要限制和约束,包括技术条件、软硬件条件、功能、性能目标约束等。3综合描述 3.1 系统目标 说明 系统最终要解决的实际问题或要达到的用户要求,系统如何能够做到客户满意。3.2 系统需求 说明 系统由上游文档规定的需求的简要说明。说明本系统,本文档涵盖的需求及功能实现部分。 3.3 系统概述 说明 简述系统功能,映射
6、详细设计的基础轮廓。用系统结构图表示系统内的包和主要类的名称、标识符和它们之间的层次结构关系,可以以系统体系结构划分,也可以由类类别划分(边界类、控制类、助手类、实体类、数据类),甚至可以由功能结构划分。 3.4 程序结构说明 说明 结合上游文件中的逻辑视图,描述最终的程序划分、结构图及功能与调用关系简要说明、程序种类说明。本节为以下详细设计的简要索引,为系统程序的上层结构体系描述。详细设计时可能得不到精确的最终程序文件名列表,但是应当尽量完整说明其种类和主要文件内容。建议使用UML图配合文字说明。 3.5 源程序及编译链接组装说明 说明 结合上游文件中的物理视图,本处为源程序和前一节的最终程
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 详细 设计 说明书 模板
限制150内