概要设计模板.docx
- 文档编号:11148908
- 上传时间:2023-05-29
- 格式:DOCX
- 页数:9
- 大小:60.69KB
概要设计模板.docx
《概要设计模板.docx》由会员分享,可在线阅读,更多相关《概要设计模板.docx(9页珍藏版)》请在冰点文库上搜索。
概要设计模板
项目名称:
项目编号:
第版
文档编号:
项目编号_PD_流水号第册/共册
Xxx模块概要设计
版本:
Ver0.1
东软集团IT人才实训中心
总页数
正文
附录
生效日期
编制:
审批:
修订记录
日期
版本
说明
作者
1.引言
说明:
简短的描述一下文档的用途、范围以及预期读者。
注意:
本模板用于编写系统概要设计,说明软件架构级涉及的基本算法、关键数据结构、主要设计思想。
为软件详细设计打下基础。
本模版列出了概要设计时需要做的比较完全的内容、可以根据项目情况适当进行裁剪。
模板格式说明:
蓝色斜体字:
是模板的说明文字,实际写文档的时候需要去掉。
紫色斜体字:
是模板的例子,实际写文档的时候需要去掉。
图表全部使用引用题注和交叉引用的方式、通过更新域、可以自动排序。
1.1术语
说明:
列出文档中使用的相关术语。
例:
表11:
技術用語
番号
用語
説明
1
UART
UniversalAsynchronousReceiverTransmitter。
1.2缩略语
说明:
按字母顺序列出文档中使用的缩略语。
例:
表12:
缩略语
番号
原词
缩写
説明
1
MAINGUIModule
UI
MAIN側GUIModule
2.系统结构
说明:
说明软件系统组成,层次结构和相互之间的关系。
描画模块block图。
若开发内容为其中一个或几个模块,需要说明该模块与其他模块之间的关联关系。
3.模块功能概述
说明:
模块的功能点概述
注:
说明模块概要功能,详细功能点将在详细设计中进行说明
例:
3.1本模块实现机能点(最好不要和标题编号使用相同的数字,可以按照第二层次标题格式来写)
■实现送信Command画面。
■MediaModule側のCommand応答データを表示する画面の作成。
■MediaModule側のStatus情報を表示する画面作成。
■表示データ的存储。
3.2本次开发变更机能点
■追加FreeCommand画面
■修改表示データ的存储格式、以减少存储空间
4.模块架构
4.1模块内部构成
说明:
这部分要描述:
1)本模块的内部组成。
2)描述内部子模块之间的数据流向,可以在模块结构图中一并表示。
3)说明每个子模块的职责。
注意:
如果待设计模块不需要再进行划分,请明确说明。
例:
ADKeyDriverModuleでは、ADkey読み取り、Keycode確定、チャタリング処理、Key状態遷移
マトリクス管理を行う。
そしてKeymessageをConsoleModuleへ送信して通知する。
图41ADKeyDriverModuleBlock
图41のADKeyDriverModuleのSubModuleの説明は表41の通りであり、Dataflowの説明は表42の
通りである。
表41:
ADKeyDriverModuleSubModule説明
SubModule
説明
GetKeyCode
Keycodeを取得する
ChatteringProcess
チャタリング処理
KeyStatusMoveManagement
KeyModule状態遷移管理
表42:
ADKeyDriverModuledataflow説明
ElementName
説明
①
AD値を取得する。
②
AD値でkeycodeを確定して、チャタリング処理を行う。
③
それぞれの各ADチャンネルのKeycodeを取得する。
④
Triggerを生成して、Key状態を管理し、該当Actionを実行する。
⑤
Keymessageを送信して、ConsoleModuleに通知する。
4.2模块的实现
说明:
根据模块框图对模块的划分、详细描述如何构建模块的各个部分、各个机能点如何被实现、可以使用如下说明手法。
状态迁移图
时序图
TimingChart
流程图
数据表
4.3变更机能的实现
说明:
变更设计时需要写、对变更的机能点详细描述。
5.模块接口设计
5.1外部接口设计
说明:
包括和系统、其他模块、硬件的接口
message/function/flag等
与其他模块配合工作时的时序图。
5.2内部接口设计
说明:
Waittime/message/function/flag等
6.
关键数据结构
说明:
对各种资源进行说明、并分析是否满足系统的要求。
6.1选用的数据结构
说明:
给出基本结构,明确具体的定义。
6.2使用规则
6.3注意事项
7.主要算法
说明:
采用的算法和基本理由的阐述。
7.1算法实现原理
说明:
才算法的基本原理,以及选用该算法的理由。
7.2算法关键流程
7.3算法使用注意事项
8.限制条件
说明本程序运行中所受到的限制条件。
例如运行时间或响应时间的限制
9.框架流程
说明:
把模块级实现的主要流程进行描述,细化到主要处理功能即可,功能级的细化将在详细设计完成。
9.1.1流程1
9.1.2流程2
10.
模块间时序
说明:
把模块间通信时序进行说明。
10.1.1主要通信主体
10.1.2时序图
例:
11.附件
11.1模块技术点整理
说明:
技术点识别
应用的设计模式
应用的算法与数据结构
使用的库函数或共通函数
11.2参考文档
编号
文档名称
版本
作者
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 概要 设计 模板