QD0320软件系统架构设计说明书模板.docx

QD0320软件系统架构设计说明书模板 TF_SW_Platform_Project_SAS_1.0TECHFAITH WIRELESS COMMUNICATION TECHNOLOGY LTD。 软件系统架构设计说明书 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 SW Tester SCM SQA QA SPM PM SSM REVISION HISTORY NO. Date Modify Description Version Composer Approver Review Cause ID Doc. No: QD0320 Ver: 1.0 TABLE OF CONTENTS 1 INTRODUCTION . 4 1.1 目的 PURPOSE . 4 1.2 范围 SCOPE . 4 1.3 术语、缩略语定义 DEFINITIONS, ACRONYMS, AND ABBREVIATIONS . 4 1.4 参考资料 REFERENCES. 5 1.5 文档路径 DOCUMENT LOCATION . 5 2 PRODUCT OVERVIEW . 5 3 SW ARCHITECTURE . 5 4 GENERAL ARCHITECTURE . 6 4.1 参考模型 REFERENCE MODEL . 6 4.2 描述 DESCRIPTION . 6 4.3 处理过程 PROCESSING ACTIONS . 6 5 ARCHITECTURAL COMPONENT DESCRIPTION . 6 5.1 构件X COMPONENT X . 6 5.1.1 描述 Description . 6 5.1.2 输入 Inputs . 7 5.1.3 输出 Outputs . 7 5.1.4 处理过程 Processing Actions. 7 6 MEMORY USAGE . 7 7 ADDITIONAL INFORMATION . 7 8 APPENDIXSAMPLE TABLE OF CONTENTS FOR SAS . 8 8.1 软件架构图 SW ARCHITECTURE DIAGRAM . 8 8.2 时间事件描述 TIMERS DESCRIPTIONS . 9 8.3 特殊的执行接口 SPECIAL EXECUTIVE INTERFACES . 9 Doc. No: QD0320 Ver: 1.0 1 Introduction 1.1 Purpose 软件架构设计是在系统需求分析建立之后，从整体上对软件结构进行分析，为各模块设计提供指导。SAS将作为软件概要设计的输入。 Architecture design gives an analysis of software architecture, which based on system requirement analysis，in order to guide sub-module design. SAS is the input to software high level design. 1.2 Scope 这部分描述SAS的编写范围。范围描述可以是针对一个独立的软件产品或平台，也可以是一个或多个软件构件，或者是一个或多个软件特性。 This section shall identify the scope of this Software Architecture Specification (SAS). The scope may be a product or platform, one or more software architecture components, or one or more software features. 例： 本文是对XX项目软件整体框架的设计描述，它基于XX芯片，XX平台，增加了XX新技术或新功能，在处理上需要涉及到XX重点信息，本文都将做以介绍。另外，本文还包括消息收发机制，按键处理机制，触摸屏事件处理机制以及各重要模块之间的关系等。 Example: This section describes the whole SW architecture design info for XX project. This project is based on XX chipset, XX platform, adds XX new technology and functions. We should pay more attention on XX critical functions which will describe detail in the following part. By the way, its also includes the message handling mechanism, key handling mechanism, touch panel handling mechanism, the relationship of important modules and so on. 1.3 Definitions, Acronyms, and Abbreviations 本节按字母顺序给出本文档引用的术语定义,术语和缩略语.本节也可参照引用其它参考文档,参考信息必须为黑体字. This section provides alphabetically organized definitions of all terms, acronyms and abbreviations needed to properly interpret this document. This may be accomplished by reference to other appendices or reference documents. Index information should be in bold. Doc. No: QD0320 Ver: 1.0 1.4 References 本节描述与系统设计相关的包括标准,规范,文档在内的所有文档列表. 所有相关的硬件设计文档应当在此列出 。 This section shall list all documents referenced in this SAS, especially all System Requirements Documents and Feature Requirements Documents，All relevant hardware interface requirements documents should also be included in this list of references. For example: 1 UI specification 1.1 2 System requirements 1.0 3 XXX software architecture design 2.0 4 XXX hardware architecture map 2.0 1.5 Document Location 请描述文档存放路径。文档路径要求是唯一的。 This shall identify the unique location where the controlled version of this SAS is archived and kept under con-figuration control. Example: ftpxx project xx module TF_SW_Platform_Project_SAS.doc 2 产品描述 Product Overview 请在此描述产品的基本功能，特点及使用环境。如：本手机具备蓝牙，红外等功能。支持3G和GSM. Present an overview of the product in which the current system is to be used, e.g., the types of services that this feature will enable. 3 软件架构 SW Architecture 请用图形描述总体软件框架，并配以详细的文字说明。如果不是新平台项目，请对重要的或新增模块加以不同颜色标识。可参考附录8.1。 This section presents the big-picture architectural view of the feature or component being architect, also with detailed text description. If its not a total new platform project, please distinct with different colors for Doc. No: QD0320 Ver: 1.0 those important and new modules. Please refer to the appendix 8.1. 4 General Architecture 请用图形描述系统所用到的通用架构。 This section presents the big-picture view of the general feature or component. 4.1 Reference Model 请描述用到的参考模型。 Mention the reference model used to model the software. e.g., the message handle model is same with opus message mechanism. 4.2 Description 请对通用系统架构进行描述，包括内外部接口介绍，各构件关系等。 Present the description of the architecture of the system being designed. Show the external and internal interfaces. Show the architectural components that make up the system. A pictorial representation of the architecture shall be included。 4.3 Processing Actions 请对每一个重要构件的处理过程进行描述。 For each component (typically a task) that has been identified as a part of the system, present a brief overview of the processing actions performed by the component in sub-sections of this section 5 构件描述Architectural Component Description 请使用下面的模版对系统架构每一个独立的构件进行描述。 Please use with the following template to describe the detail design for each individual architectural component. 5.1 X Component X 5.1.1 描述 Description 简单对此构件进行说明,对于有风险的设计要特别注明。 Provide a brief description of this component, if there is risk, please highlight it and describe how to resolve it. Doc. No: QD0320 Ver: 1.0 5.1.2 输入 Inputs 请在此列出输入的组件 List all inputs to this component 5.1.3 输出 Outputs 请在此列出输出的组件 List all outputs of this component 5.1.4 处理过程 Processing Actions 可以借用图表方式对此构件的处理过程进行详细描述。 Describe in detail the processing actions performed by this component. Use diagrams to represent the internal structure of this component 6 资源使用状况 Memory Usage 此部分主要介绍系统资源开销情况，如RAM/ROM/FS等。 Use this section to compute the RAM/ROM/FS requirements for the individual components. If multiple options are available they shall be discussed and documented here 7 其它 Additional Information 此部分可以增加一些附加信息。如果没有，无需填写。 This last section would be used at the discretion of the designers to document any additional information which they feel might be useful to others to help them learn how the layer works. 例如： 相关的系统参数，如电池校准数据，射频校准数据，音频参数，以及其他和硬件相关的接口。具体可以参照 XX文档。 Example: The system parameter, such as battery calibration data, RF calibration data, speaker/receiver audio parameter, and other parameters with hardware. Detailed info please refers to XX document. Doc. No: QD0320 Ver: 1.0 8 附 Appendix：Sample table of contents for SAS 8.1 SW Architecture Diagram By Skyworks By 3rd parties CALL, By Techfaith SMS, Alarm, All Java EMS, PDA Schedule, Settings, WAP, Camera Games DictionPhone Games, Apps SS QQ Profile MMS MultiMeary, Book Java Network Palette mydata dia Stock Java VM Application Interface ( API) Net Module Graphic User Hand File System T9 Interface Writing Skyworks Block Device Char Device Driver Graphic Device Driver Kernel Sys related: Driver Interface Interface Interface Interrupt Management Memory Mapping Touch Panel Flash Chipnuts Keypad System Clock Uart Chipnuts Driver Driver Driver Driver Power Management Driv Driver PS er CPU Chipnuts ROM/RAM/ FLASH RS 232 LCD, Keypad, Touch Panel Memory Management Parts System Clock 注意： Power Management 没有填充颜色的表示旧有功能模块； Parts ，表示新增功能模块； ，表示需要修改的重要功能模块； 其中chipnuts 是新增模块，对此部分及其相关模块应特别注意。 Notes： Normal modules without filling color; New module with red color; Important modify module with blue color; The chipnuts is the new chipset in this project; we should pay high attentio