QD0091软件接口说明书模板 TF_SW_Platform_Project_Module_SIS_21.doc

德信无线通讯科技有限公司 TECHFAITH WIRELESS COMMUNICATION TECHNOLOGY LTD。 软件接口设计说明书 Software Interface Specification（SIS） Doc ID: State: Draft( Reviewed ( Initial( Revised( Doc Type: SW Req( SW Des( SCM( TEST( SW Plan( SQA( Project: Module: Current Version: Previous Version： Pages：Release Date： { Status: Draft: 编制者自己写好后,没有经过评审前的状态; Reviewed: 已经评审过的状态; Initial: 评审问题修改后,入库前要把状态改成Initial; Revised: 因某种原因需从库中取出进行变更,变更后入库前需把状态改成Revised Version: 入库前是0.1,入库时要改为1.0,从库中取出变更的中间版本是1.1、1.2…等,第二次入库前要改为2.0，以后以此类推 } Composer Reviser Reviewer Related SQC SCM SQA QA SPM PM Approver SSM REVISION HISTORY NO. Date Modify Cause Description Version Composer Approver Review ID TABLE OF CONTENTS 1. 介绍 Introduction 3 1.1 目的 Purpose 3 1.2 范围 Scope 3 1.3 定义、术语、缩略语Definitions, Acronyms, and Abbreviations 4 1.4 参考资料 References 4 1.5 文档路径 Document Location 4 2 构件/模块说明 Component/Module Overview 4 3 接口 Interface 4 3.1 类型定义 Type Define 4 3.2 数据结构 Data structure 5 3.3 接口函数Interface functions 5 3.3.1 函数X Function X 5 4 Appendix 5 4.1 构件/模块说明示例 Component / Module Overview Sample 5 4.2 接口示例 Interface Sample 7 4.2.1 类型定义 Type Define 7 4.2.2 数据结构 Data Structure 8 4.2.3 函数 Funtions 8 介绍 Introduction 目的 Purpose { 本接口文档用于描述和XX模块相关的各种接口设计。便于了解本模块在系统中的位置，并为相关模块提供接口详细的调用说明。 This document describes the interfaces related with XX module, purpose on give a good understand with this module and related. This document provides detail description of interfaces called by other modules. } 范围 Scope { 本文涉及到该模块在系统中的位置说明和各种接口描述。接口描述包括以下几个方面： This document involved the position of this module in whole system and all interfaces introduction. The interfaces description should include the following items: 各个接口的用途和使用说明。 The utility and description of all interfaces. 接口参数的类型定义和有效范围的说明。 Description of the parameter definition. 接口函数中调用的内存块参数的分配/释放等约定。 How to allocate or free the memory used in interface functions. } 定义、术语、缩略语Def