分类: Delphi
2012-04-27 16:19:27
2012年4月13日 星期五 天气多云
前段时间通过阅读HP架构模板文档,自己也尝试着写了一个Linux FB框架分析文档。总体感觉,如果纯粹按照HP架构模板文档来操作,总感觉有些不顺手的地方,因此在此基础上,针对自己的理解和实际情况将模板改良如下(针对设计文档,对于分析文档将需求部分去掉即可):
1.简介
1.1背景知识
介绍要理解整个系统需要具备的一些基本的常识
1.2文档目的
此文档想达到的目的,比如给驱动设计人员提供参考
1.3系统目标
总体上系统要达到的功能目标
1.4关键需求
在众多功能目标中最重要的功能需求
1.5架构范围
主要对整个系统的哪些部分进行架构,也即要分析(设计)的系统的界限
1.6主要架构决策
主要讲架构方面的关键决策
1.7读者
如驱动维护人员、架构师、驱动设计人员等
1.8状态
软件开发周期位于哪个阶段,设计阶段还是编码阶段或维护阶段
1.9架构方法
如:4 1视图等
2.系统目的
2.1系统环境
给出整个系统的框图,介绍所设计(分析)的系统在整个系统的位置,尤其重点介绍所设计(分析)系统之外的部分。
2.2系统需求
2.2.1功能场景
给出系统所具有的功能包括哪些方面,给出用例及用例分解,确定所要设计系统满足的需求
2.2.2非功能场景
2.2.2.1质量场景
比如在掉电情况下flash的恢复,比如滤波处理减少漂移等
2.2.2.2架构约束
系统的一些限制,如:如尽量使用标准接口,以方便第三方软件等
2.2.2.3架构规则
系统架构中的一些限制,如:软硬分离,功能分离
3.系统结构
3.1系统框图
给出设计(分析)的系统的总体框图,对于架构风格、设计模式等的描述可以加以注释,也可以增加设计决策部分加以阐述。
3.2系统接口
给出设计(分析)系统的总体接口,一般为给系统其它部分使用的接口,如文件操作接口等
4.子系统
4.1 子系统总体框图
4.2 子系统接口
5.系统组件
5.1组件结构(XX组件)
给出系统的各个组件介绍,包括组件有哪些接口,组件与哪些组件关联等,此处可以用类图表示此组件与各个组件的关系
5.2组件接口(XX组件接口)
给出各个组件的接口介绍
6.系统场景
主要从纵深的角度对各个流程进行分析
7.其它视图
7.1开发视图
介绍目录结构,
7.2进程视图
体现并发性、线程与进程机制、消息通讯机制等等与进程相关的一系列内容。
7.3部署视图
一般不做涉及
8.概念框架
介绍主要的概念
9.结论
9.附录
介绍主要结构体,示例程序等