版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
系统设计报告编写规范文件编号:NW506101生效日期:2000.3.20受控编号:密级:秘密版次:Ver2.1修改状态:总页数19正文4附录15编制:胡景德审核:袁淮、孟莉批准:孟莉沈阳东大阿尔派软件股份有限公司(版权所有,翻版必究)文件修改控制修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期
目录TOC\o"1-3"\n1.目的2.适用范围3.术语及缩略语4.编写规范4.1排版规范4.2模板使用5.引用文件6.附录
目的系统设计报告主要为使软件产品和软件项目满足规定的软件规格要求而确定软件系统的体系结构、组成成分、数据组织、模块、内外部接口。主要任务有:建立软件产品和软件项目目标系统的总体结构。对于大规模软件系统,应分为若干子系统,在本报告中只说明总体设计,然后为每个子系统编写《系统设计报告》;总体设计;模块设计;涉及使用数据库的设计需编写数据库设计。适用范围适用于软件开发设计阶段的《系统设计报告》的编写。 术语及缩略语本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。 编写规范排版规范整个规范由2节构成,模板单独一节。正文样式采用“规范正文”。标题编号采用每节独立编号。模板使用系统设计报告的编写可依据具体情况选用摸板的格式或编写指南的格式。拷贝规范。删除第一节(系统设计报告封面前的所有页)。在修改完内容后,更新目录域和相关的页数域。引用文件(无)附录以下部分为系统设计报告的模板与编写指南。系统设计报告 PAGE3/5沈阳东大阿尔派软件股份有限公司密级:机密文档编号: 第版分册名称: 第册/共册项目名称(项目编号)系统设计报告(部门名称)沈阳东大阿尔派软件股份有限公司总页数正文附录生效日期:年月日编制:审核:批准:目录TOC\t"标题1,1,标题2,2,标题3,3"1.引言 GOTOBUTTON_Toc39959162811.1目的 GOTOBUTTON_Toc39959162911.2背景 GOTOBUTTON_Toc39959163011.3术语 GOTOBUTTON_Toc39959163111.4参考资料 GOTOBUTTON_Toc39959163212.总体设计 GOTOBUTTON_Toc39959163312.1系统运行环境 GOTOBUTTON_Toc39959163412.2软件功能描述 GOTOBUTTON_Toc39959163512.3软件结构 GOTOBUTTON_Toc39959163612.4技术路线 GOTOBUTTON_Toc39959163712.5外部接口 GOTOBUTTON_Toc39959163822.5.1用户接口 GOTOBUTTON_Toc39959163922.5.2软件接口 GOTOBUTTON_Toc39959164022.5.3其它接口 GOTOBUTTON_Toc39959164123.模块设计 GOTOBUTTON_Toc39959164223.1功能 GOTOBUTTON_Toc39959164323.2性能 GOTOBUTTON_Toc39959164423.3内部接口 GOTOBUTTON_Toc39959164523.4外部存贮结构设计 GOTOBUTTON_Toc39959164624.故障处理说明 GOTOBUTTON_Toc39959164725.数据库设计 GOTOBUTTON_Toc39959164825.1数据字典设计 GOTOBUTTON_Toc39959164925.2安全保密设计 GOTOBUTTON_Toc3995916502系统设计报告 4/5系统设计报告 3/5沈阳东大阿尔派软件股份有限公司1. 引言1.1 目的说明编写本《系统设计说明书》的目的。1.2 背景:说明理解本报告所需的背景,如与公司其它软件之间的联系等。1.3 术语列出本系统设计说明书中专门术语的定义和英文缩写词的原词组。1.4 参考资料:列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布日期和出版单位。编号资料名称简介作者日期出版单位列出编写本报告时需查阅的Intenet上杂志、专业著作、技术标准以及他们的网址。网点简介 总体设计系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置。软件环境包括:操作系统、数据库、以及其它支撑软件;硬件环境包括:主机类型、网络类型、存储器容量、其它特殊设备。软件功能描述描述被开发软件的功能,如有同等作用的文件(如已编写的《软件功能规格说明书》)则可直接在此引述该文件名及归档的部门即可。软件结构以图表形式给出软件子系统结构和模块组成结构。凡单独编写《系统设计报告》的子系统,其内部自用的模块不必列出。技术路线给出本软件系统在实现过程中所采用的技术路线、方法。对比较新的技术给予详细的阐述及必要的说明,在可能的情况下给出相应的技术参考资料。外部接口用户接口描述该软件与用户的接口,包括用户输入输出界面样式、操作方式和界面间的转移关系。如具有等同作用的文件(如使用开发工具编写的界面原型程序等),本处仅需列出该文件名、保管部门即可。软件接口描述该软件与其它系统的软件接口,主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口,如具有等同作用的文件(如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等),本处仅需列出该文件名、保管部门即可。其它接口描述该软件与其它系统的其它类型接口,主要说明其它系统提供的和本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等,如具有等同作用的文件,本处仅需列出该文件名、保管部门即可。模块设计功能简述各模块的功能。性能说明对各模块的性能要求,包括精度、时间特性和处理速度。内部接口说明各模块之间接口,包括:各模块的用途、使用(调用)方式;说明其每个子程序(方法,Method)、特性(Property)和反馈的事件(Event),相应的输入、输出项说明;指明各模块内含的各类外部接口,并列出这些外部接口说明材料名。外部存贮结构设计说明本系统存贮于磁盘等持久性存贮介质,而且不是由数据库管理系统进行管理的数据的组织结构,包括数据名称、用途、每个数据项的标识名、类型和含义,组织结构、访问方法和存储要求。系统设计报告 5/5故障处理说明说明本系统所采用的基本错误处理方法和原则,例如:统一采用C++try-catch错误方法,所有错误最终必须以界面形式向用户说明。用一览表方式说明各类可能的错误或故障出现时系统的处理方法和补救措施。数据库设计数据字典设计对数据库设计中涉及到的各种项目,如数据项、记录、表、数据库等建立数据字典,以说明它们的标识符、同义名及有关信息,并说明对此数据字典设计的基本考虑。凡采用数据库设计工具(如ER图设计工具)生成的数据字典,本处仅需列出对应的文件名、保管部门即可。安全保密设计说明在数据库的设计中,如何通过区分不同的访问者、不同的访问类型和不同的数据对象,进行分别对待而获得的数据库安全保密设计考虑。系统设计报告编写指南系统设计报告编写指南之一1. Introduction介绍描述这个文档的编写目的;描述这个文档的适用范围;描述这个文档的读者;确定这个系统/产品的名称和/或版本号;定义重要的术语、缩写词或缩略语;总结(或给出一个概要)这个文档的内容。2. SystemOverview系统概述对软件系统的一般性描述,包括系统的功能和其他与设计相关的内容。3. DesignConsiderations设计上的考虑本节描述在完成一个完整的设计解决方案之前必须阐明或解决的问题。3.1 AssumptionsandDependencies假设和依赖相关的软件和硬件操作系统最终用户特征在功能上可能发生的变化3.2 GeneralConstraints一般限制描述对软件系统的设计有重要影响的全局限制或约束。硬件或软件环境;最终用户环境;资源的可用性和挥发性;标准的兼容;(option)协同工作的要求;接口/协议的要求;数据储存和发布要求;安全性的要求(或其它类似的规则);内存和其它的容量限制;性能要求;网络通信;(option)验证和确认的要求(测试);其他质量目标的要求;在需求分析说明书中所描述的其它要求。3.3 GoalsandGuidelines目标和指导方针描述所有支配软件系统设计的目标、指导方针、原则或者优先权。尽量保持它简单易用;强调速度与内存使用的矛盾;象对待一个已经存在的产品那样工作、观察或者体会。3.4 DevelopmentMethods开发方法简要地描述用于软件设计的方法。如果采用正式/已公布的方法,那么就要对这些方法进行详细描述,同时还要简单解释一下为什么采用这个方法或其中的某些部分。4. ArchitecturalStrategies体系结构策略描述所有影响整个系统的组织和结构的设计决定和/或策略,这些策略深入描述系统体系结构所使用的关键技术和机制。对于每个设计决定和/或策略都要描述其产生原因(可能要引用前面阐述的设计目标和原则),以及它们是如何得到均衡和折中的,涉及内容:使用特定类型产品(编程语言、数据库、函数库等);重用现有组件;软件未来扩展和升级的计划;用户接口模型(或系统的输入和输出模型);硬件或软件接口模型;错误检测和恢复;内存管理策略;外部数据库和/或数据存储管理和维护;网络上分布式数据或控制;控制的一般方法;并发和同步;通信机制;其它资源的管理。每一个被采用的重要战略必须在相应的子章节内加以讨论。5. SystemArchitecture系统体系结构在本节应该在一个较高的层次来说明如何将系统的功能划分给各个子系统或组件,不要涉及这些组件本身的细节(后面有一个小节专门来详细描述组件)。本节的主要目标是描述系统是如何进行分解、这样分解的原因以及各部分是如何协作工作以完成预定功能。在较高的层次上描述系统所要承担的主要工作责任、系统所扮演的各种角色;描述如何将系统划分成各个组件/子系统,每个组件/子系统的作用是什么;描述高层组件之间是如何协调工作已完成预期的功能;进行系统分解时所采用的基本原则;可以使用图表、模型、流程图等形式来描述上述内容。5.1 SubsystemArchitecture子系统的体系结构建立一个子章节来详细描述某一组件的作用,进一步描述该组件是如何分为子组件的以及各个子组件之间的关系。6. PoliciesandTactics政策和实施策略描述影响系统的接口细节和系统实现细节的各个方面:选择特定产品来使用(如编译器、解释器、数据库、函数库等);工程上的折中;编码规范和惯例;一个或多个子系统、模块或子程序的协议;选择某一特定算法或编程用语来实现系统的一部分;功能性说明;保证需求可回溯性的计划;软件测试计划;软件维护计划;最终用户、软件、硬件和通信的接口;将源代码按照物理形态(文件和路径)进行分层组织;如何构造和/或产生系统的交付物(如何编译、链接、加载等)。以上各项内容必须有相应的子章节进行讨论。如果还有其他方案可供选择时,要说明你没有选择这些方案的原因。可以使用图表、模型、流程图等形式来描述上述内容。7. DetailedSystemDesign详细设计在系统体系结构中所描述的绝大多数组件需要在本章节进行更深一步的讨论,同样,其它低层的组件和子组件也需要描述。为每个组件建立一个子章节来详细描述组件,包括以下内容:Classification分类组件的种类,例如是一个子系统、模块、类、包、函数、文件等等。Definition定义组件的确切用途和语义。可能需要参照需求说明。Responsibilities责任该组件的主要责任和/或行为,要完成什么?扮演什么角色?给客户提供哪写服务?可能需要参照需求说明。Constraints约束与该组件相关的任何假设、限制、或者约束,如时间、存储或组件状态,还可能包括与该组件进行交互的规则(前提条件,后置条件,不变量,其它在输入和输出值、局部或全局值上的限制,数据格式和数据存取,同步,例外等)。Composition合成 描述组成该组件的子组件及其用途。Uses/Interactions用户/接口描述该组件与其它组件之间的关系,如该组件被哪些组件所使用?该组件使用了哪些其它组件?这关系到所使用的交互作用的方法。面向对象的设计必须描述那些已知的和预期的子类、超类和元类。Resources资源描述这个组件所管理的、影响的和使用的所有资源,如内存、处理器、打印机、数据库或软件库,要描述可能存在的资源竞争、死锁等情况以及相应的解决方案。Processing过程描述该组件的执行过程,包括所使用的算法、状态的变化、相关的时间或空间的复杂性、并发、创建方法、初始化、清除和例外情况的处理。Interface/Exports界面/出口描述该组件所提供的服务,如资源、数据、类型、常量、子程序和例外等集合,明确定义每一个服务元素,即分类、定义、责任、约束、组合、使用、资源、处理和接口的描述。 7.1 DetailedSubsystemDesign详细子系统设计在本章节内对该组件进行更详细描述,可使用一些复杂的图表来显示组件结构、行为、或者信息/控制流。8. Glossary词汇表列出在文档中所定义的术语和概念。9. Bibliography参考书目一个参考书目和/或相关出版物的列表。系统设计报告编写指南之二AUTONUMLGL. Objectives目标描述系统设计报告的内容和目的。AUTONUMLGL. Scope范围 适用于指导包含设计阶段的项目编写系统设计报告。References参考OutstandingIssues尚存主要问题Approvals批准R&D单位负责人Responsibilities 职责6.1 开发部长对系统设计报告进行审核;6.2 项目管理部门组织对系统设计报告进行评审;6.3 设计人员提交符合本指南的系统设计报告。6.4 设计人员对设计阶段的文档进行配置管理。Template模板7.1 Introduction绪论项目概述;所设计的产品的概述。7.2 SystemDescription系统描述7.2.1 SupportforRequirements对需求的支持设计满足需求的程度;设计未能完全满足的需求及其原因。7.2.2SystemPurpose系统目标简述所开发的系统,如果本系统同其他系统有不论是手工还是计算机方面的关系,也要描述。可参考需求分析报告的内容。 7.2.3 InputsandOutputs输入和输出详细描述系统的所有输入和输出,包括界面设计、报表设计,参数格式。7.2.4 Functions功能描述系统所提供的所有功能。7.2.5 Storeddata数据存贮简述系统的数据文件。7.2.6 Securityandbackup安全和备份系统在安全和备份方面的考虑与设计,包括回滚和恢复。7.2.7 Exceptionhandling例外处理系统产生的所有错误信息的列表,包括错误发生的条件以及所采取的措施。所有例外情况的列表,以及系统所采取的措施。7.2.8 Impactassessment影响评估描述系统对现有环境的重要影响,如工序的变化,工作量的变化和硬件的变化。可以参照需求分析报告的内容。7.3 UserProcedures用户规程7.3.1 Systemnavigation系统导航描述那些使用户能充分使用系统的规则;7.3.2 Routine例程描述在正常工作环境下,系统预期的使用方法;使用流程图来描述例程,流程图要带有辅助描述,描述那些使用每个功能的用户的类型。7.3.3 Exception例外处理描述系统在异常情况下所使用的处理方式,如网络失效时的数据恢复。7.3.4 Installation安装描述系统的安装过程。7.4 Systemarchitecture系统结构7.4.1 Designprinciples设计原则描述系统设计所采用的策略,如用户界面的形式,所使用的标准产品等。7.4.2 Designrationale设计原理描述进行设计的依据,如数据库结构等;模块调用原理:是内部还是外部,是修改还是重建或重用。7.4.3 Softwarecomponentsandinterfaces软件组件和接口描述系统中的主要组件,包括它们之间传递的包和数据流;数据流图和功能分解图;描述所引用的外部模块。7.4.4 Capacityrequirements 系统资源需求估计系统容量等需求的临界值,如内存、磁盘空间和、传输速率等。7.4.5 Systemstructure系统结构描述系统的各模块是如何连接在一起工作的。7.5 Data数据7.5.1 Definitions定义对系统中包含的所有数据项的描述。7.5.2 Databasedesign数据库设计对逻辑数据库/文件设计的描述;对物理数据库/文件设计的描述;数据校验规则。7.5.3 Calculations算法定义系统所采用的计算或算法;确定实现这些算法的流程。7.5.4 Datamanagementprocedures数据管理程序描述对系统数据的管理流程,如存档等。7.6 Modulespecifications模块说明详细描述每个模块的逻辑、功能或每个模块的所有状态、与其他模块的关联、状态的变迁、存在的条件及采取的动作;使用简洁、标准的语言;说明每个模块的输入和输出。7.7 Physicalenvironment物理环境描述建立和运行系统所需要的物理环境。7.8 Appendices附录数据流图数据模型
公司治理的核心原则黄一义
编译什么是公司治理?
公司治理是调整公司企业各方参与者关系的规范,这些参与者主要包括三个方面:股东;(以CEO为首的)公司管理层;董事会及其成员。这些参与者决定着公司的发展方向和绩效。公司治理结构的目标是要在这三方面参与者之间建立起两种有效的负责任(accountable)的关系,即董事会对管理层的有效监督和股东对董事会的有效制约。经验表明,股东积极行使其所有者权力参与公司事务,会使公司管理层更加负责且更加关注公司的业绩,因而对股东的投资带来更多的回报。美国的一家大型信托机构棗拥有1000多亿美元资产的加州雇员退休系统1996年的一项研究表明,这种积极的参与使美国公司新增利润达1.5亿美元。公司治理的核心原则
公司治理的核心原则对维持一个公开、公平的资本市场是必须的,是资本市场吸引投资者的广泛参与并保持其竞争力和吸引力的重要规范。它包含如下要点:可信赖性(Accountability)对股东的义务公司董事会和管理层必须对股东负责。尤其是公司董事在以下几方面有特殊的责任:(1)树立公司的战略观念,以确保股东长期价值的增加成为公司的首要考虑;(2)依据第一项要求,对其自身以及公司管理班子的绩效进行持续的评估。对股东提出的关于公司状况和管理层绩效的问题,董事会和管理层应该保持开放性并使之易于得到解答,董事会应当向市场披露其做出一些重大决定的方式,这些决定涉及公司经理的薪酬如何确定,公司的战略规划,新董事的提名和公司经理人员的任命和考核等。新董事侯选人的背景,包括其与公司的经济关系也应向公司股东披露。监督董事会应当具有对公司管理层进行有效监督的能力,股东对董事会应具有同样的能力。为此,股东应能通过适当的投票程序行使其权力。经理的薪酬建立可信赖性的一种最有效的方法是使经理人员的利益与股东的利益保持一致。管理层的薪酬应与公司的长期业绩表现挂钩。透明度公开性一个自由、有效的具有全球竞争力的资本市场必须建立在公开性的基础上。如果一个市场不能使投资者对其公开性具有信心,投资者就会退出这一市场。会计准则目前不同的市场采用不同的会计准则,这使国际投资者的有效分析难以进行。公司应努力采用国际会计准则。一致性报告在某些市场一些机构颁布“最佳行为准则”作为一种标准的公司治理规范。在采纳这些准则的市场,公司应向股东报告其是否遵守这些准则,并说明其不遵守的理由。公平公平对待在所有的市场对所有的股东均应以公平相待的方式一视同仁,包括外国股东在内。公司应特别注意尊重少数股东的利益,并且不采取对投资者具有实质性损害的行为。一股一票一般说来,每一股应使其持有者在股东大会上享有其相应的一份投票权。选举方法代理资料代理资料应当简洁、明确,并包含有能使股东对有关问题做出知情决定的适当信息。此外,代理资料的发放应采取鼓励而不是抑制股东参与的方式进行,这一要求包括对会议和投票日期的适当选择。计票所有的股东选票,不论是以本人投票或通过代理的方式投票,均应正规地予以统计,并将其结果正式地宣布。相反的做法意味着对一部分股东授予特权,并且不利于公司管理层准确地了解全体股东的愿望和要求。技术只要有可能,各公司均应采用新技术以使代理投票的过程更方便、更有效且更节省。最佳行为准则建立准则各国资本市场均应建立适当的“最佳行为准则”,使公司的董事和经理人员能据此对自身的行为进行规范,并使其明确其与股东的关系及其对股东负有的责任。这一准则体现了一种标准,它来自于最优秀的公司治理的实践。一旦“最佳公司行为准则”建立起来,公司应当遵守这一准则并向股东报告其对这一规则的任何违反行为。评估和改进市场的各方参与者是应对这一准则进行评估以确保其具有全球竞争力。长期观点
公司董事和管理层应具备长期的战略设想,以保证股东价值的增加。尽管不同的投资者采用不同的投资策略,并具有不同的投资强度,投资者仍应鼓励公司管理者抵御短期行为,在关键的时刻对管理者提供支持,并对其使公司成功地产生长期超额回报的业绩予以奖赏。附1首席独立董事的职务责任·首席执行官(CEO)是公司的最高行政负责人,其职责为:*对公司的日常事务进行
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 眼科全飞手术术前准备
- 2024年度煤炭行业国际贸易结算采购合同3篇
- 远程医疗技术升级-洞察分析
- 2024年中英文环保材料研发与生产合作协议3篇
- 校园消防安全培训
- 2024年度医疗器械公司员工薪酬及福利合同范本3篇
- 油藏模拟与优化-洞察分析
- 2024年家电代销采购合同范本3篇
- 行为干预技术-洞察分析
- 2024年中老双边房地产投资开发合同3篇
- 消防部队干部竞争上岗答辩题1
- 增服叶酸预防神经管缺陷理论知识考核试题及答案
- 施工现场临水施工方案完整
- 单证管理岗工作总结与计划
- 人教版九年级上册数学 21.3 实际问题与一元二次方程(传播问题)专题练习(Word版含答案)
- 安全安全隐患整改通知单及回复
- GB∕T 799-2020 地脚螺栓-行业标准
- “僵尸型”社会组织注销登记表
- 田径活动记录第一学期记录
- CDI-EM60系列变频调速器使用说明书
- 【汇总】高二政治选择性必修三(统编版) 重点知识点汇总
评论
0/150
提交评论