XXX公司开发规范.doc

R&D/WI-003

开发规范I

版本：B

受控状态：

分发号：

发布

文件状态
[ ] 草稿文件
[ √ ] 正式文件
[ ] 更改正式文件
文件标识

当前版本

作者

完成日期

版 本 历 史
版本/状态
作者
起始日期
结束日期
备注

一个可靠的产品（硬件和软件）往往由可靠的、高效的开发机制保证，开发机制是否合理会直接影响到开发的进度以及开发的质量。
从整个开发流程考虑，可分为硬件开发，驱动开发，系统软件开发，应用软件开发，配置软件和网管软件的开发五个过程。为了更有效的发挥每个项目组成员的特长，同时为了保证整个产品的质量，开发的每个过程之间都必须接口清晰，且前一个过程必须对下一个过程负责。以下用图例表示各过程之间的关系。

从图中可看出，各开发过程密不可分，其中，除了硬件开发以硬件为主外，其余4个过程都以软件为主。
就工作的重要性而言，硬件开发处于宝塔的底部，虽不与用户直接相关，但却是最基础，最重要的一环。它是整个建筑的基石，直接影响到其它各个环节乃至整个系统的性能，必须进行有效的评估来验证其可靠性，稳定性，一致性。
驱动开发是硬件系统和软件系统之间的桥梁。通过它，我们可以把这两个系统完全独立开，使硬件工程师和软件工程师能更好地关注各自领域的开发，便于故障排除，也更便于软件移植。
系统软件开发是软件开发的核心，是协调员，调度各进程，各任务的运行，是评价软件系统的重要依据之一。不过对于嵌入式系统，系统软件开发已独立成为通用性产品，软件工程师只需熟悉它并使用它即可，而不必花费时间进行这一环节开发。
应用软件开发是我们把新开发的设备产品化的重要过程。设备的功能实现都在这一环节中完成。
配置软件和网管开发是产品和用户之间联系的窗口。一个友好的，智能化，通用化的用户界面也是衡量产品质量以及延伸出服务质量的重要依据之一。

如果把这五个过程打个比方，就像建造一座大厦，硬件开发是选素材，是原材料的粗加工；驱动开发是做模具的过程，按照不同的要求定制各种基本的模块，种类越多，今后建造出建筑的种类也越多；系统软件开发是建造过程中的几个最基本的动作，以及各动作之间如何协调分配，以保证整个建造过程次序井然；应用软件开发是按用户要求施工，完成满足用户需要的式样；配置软件和网管开发是交付给用户使用前的装饰，它提供用户使用的界面。

进行更有效的分工协作最重要的一点就是分清各个环节之间的接口，每两个相关环节以此接口为标准进行协作，每个环节完成的任务符合接口标准，即可提交给下一环节。这样才能对整个产品质量具有有效的评估，故障排除也容易定位。以下列表提出各过程之间的协作关系。

以上列表指明了各个工程师之间工作的相互关系以及工作接口规范，以下将对工程师的工作职责作具体的明确。

硬件工程师职责

向设备驱动工程师提供必要的资料如下：
1. I/O Memory Mapping文档
文档中应包括整个系统的地址分配情况，每个功能模块入口地址的分配情况；
对CPLD/FPGA内的寄存器位操作，应标明位的定义，默认值，以及read/write模式。（格式可参考芯片资料）
2. 芯片资料
3. 原理图
4. CPLD/FPGA的逻辑图，状态图或VHDL源文件
5. 关于能证明I/O Access可靠的测试程序，包括静态（逻辑的）和动态（时序的）两个方面。常见的方法是连续多次不间断对目标I/O操作，结果正常，一般认为I/O Access是可靠的。如果需要在两次I/O操作之间增加延时的，必须详细说明其性能指标（如最小延时时间等）

设备驱动工程师职责

向应用软件工程师提供必要的资料如下：
1. API文挡，包括：
Ø 模块初始化函数定义
Ø 模块功能函数定义（包括配置信息，状态查询，模块测试，软件版本信息等）
Ø 其他功能函数定义（包括内部功能函数，公用功能函数，中断服务例程等）
Ø 模块功能测试流程。对于某些复杂的功能测试，应编写流程便于应用软件工程师理解。
2. BSP文档（如果有RTOS的），提供RTOS管理接口，包括内存，任务，中断，抢占式服务的管理
3. 关于能证明功能可靠实现的测试程序，常见的方法是输入合法参数和非法参数，调用功能函数后能得到相应的结果，一般认为功能函数是可靠的。其中合法参数通常指正常范围内的参数值，非法参数是在正常定义范围外的参数值。

系统开发工程师职责

向应用软件工程师提供必要的资料如下：
1. 应用软件工程师系统调用函数的相关文档，包括函数定义（服务例程，公用函数等），数据结构定义，系统资源定义，函数应用举例等。
2. 关于能证明功能可靠实现的测试程序。由于系统软件是软件的核心部分，其性能指标直接影响整个软件的性能，因此必须进行严格的白盒测试。在测试程序中，测试内容必须完整，测试方法必须严密。对于某些复杂的功能测试，应编写流程便于应用软件工程师理解。

应用软件工程师职责

向网管开发工程师提供必要的资料如下：
1. 用户界面互操作接口文档
该文档包括命令格式的定义，上、下位机的通讯协议，出错信息定义等。如果需要在两次命令发送或接收操作之间增加延时的，必须详细注明其性能指标（如最小延时时间等）
2. 关于能证明功能可靠实现的测试程序，常见的方法是利用网管开发工程师提供的测试软件进行功能和性能的测试，根据回送结果评估互操作接口的功能和性能指标。

网管开发工程师职责

向用户提供必要的资料如下：
1. 用户界面操作说明的文档。
该文档针对不同权限的用户分别说明
2. 用户界面出错信息说明的文档
该文档包括出错信息的定义，以及出错信息可能发生的原因。
3. 关于能证明功能可靠实现的测试程序，常见的方法是利用回显机制（Debug版本下），显示输入的参数，如果与用户界面互操作接口文档中定义一致则注明参数传递可靠。

以上的职责分工不断强调的两点，也是最重要的两点是完整文档的提供和各接口可靠的测试。只有充分满足这两点的条件下，分工协作才是高效的和高质量的。产品才是真正可靠的。
开发规范II
文件编号
R&D/WI-003
修订状态
B/0
页 次
6 / 6
生效日期
2004-03-15