《8-开发类文档写作讲义资料》由会员分享，可在线阅读，更多相关《8-开发类文档写作讲义资料（38页珍藏版）》请在金锄头文库上搜索。
1、开发类文档写作,第八课,本节的目的,了解开发类技术文档的写作方法与格式 掌握开发类软件文档的写作要点 熟悉常用的开发类文档：可行性分析报告、软件需求规范、软件设计文档、编程接口API、界面设计说明、软件测试报告,可行性分析报告,主要内容,全面深入地进行市场分析、预测 对资源开发项目要深入研究确定资源的可利用量，资源的自然品质，资源的赋存条件和开发利用价值 深入进行项目建设方案设计，包括：项目的建设规模与产品方案、主要设备方案、环境影响问题、人力资源配置、项目进度计划、所需投资估算、.,案例分析,家庭理财系统可行性分析报告,需求分析文档,需求定义及其包含的内容,需求是系统的基础，陈述系统做什么，
2、解决do what，而不是how to do 功能需求：指系统必须完成的那些事，即系统要完成用户提出的各种功能要求 非功能需求：指软件必须具备的品质或属性，如可靠性、系统响应时间、容错、可扩展性等 设计约束：指客户提出的一些补充约束说明，如系统必须基于SOA、采用Oracle、必须采用Unix服务器等技术要求。,什么是需求分析？,目标：分析客户的需求是什么（分析原系统功能、存在的问题、对未来系统的期望），全面理解客户的各项要求，准确地表达所接受的客户需求。 定义：需求分析是获取需求、表达需求和验证需求的过程，最终形成一个客户和开发人员都遵守的规约：软件需求规格说明书。 需求规格说明书：详细记录
3、项目的目标、约束条件、功能需求、非功能需求、接口需求、开发运行环境要求等内容。,需求分析的I/O,原系统,存在问题,客户期望,需求规 格说明,需求 分析,输入,处理,输出,获取需求与表达需求,获取需求：问卷调查、客户访谈 表达需求：自然语言、用例模型（UML）,一些基本原则,准则1：使用简单的语法。例，系统从账户余额中扣除100元 准则2：明确地写出“谁控制球”：句子的主语（执行者）必须明确 准则3：从系统外部描述系统,“系统读取ATM卡和PIN号码，并从帐号余额中扣除一定数量” - 系统内部的角度 应改为： “用户插入ATM卡并输入PIN号码” “系统从帐号余额中扣除一定数量”,一些基本原则
4、（二）,准则4：显示执行者的意图而不是动作,修改前： 1）系统要求用户输入名字 2）用户输入名字 3）系统要求用户输入地址 4）用户输入地址 5）用户点击“确定” 6）系统. 修改后： 1）用户输入名字和地址 2）系统,一些基本原则（三）,准则5：“确认”而不是“检查与否”,修改前： 1）系统检查密码是否正确 2）如果密码正确，系统 修改后： 1）系统确认密码正确。 2）系统,一些基本原则（四）,准则6：循环表达“循环执行步骤x到y，直到条件满足”,1）顾客提供帐号或者名字和地址 2）系统查出顾客的爱好信息 3）用户选择一个商品，并做上购买的标记 4）系统将这个商品加入到顾客的“购物车”中 顾
5、客重复步骤3-4，直到顾客指明完成了选购 5）顾客购买所有在购物车中的商品,案例分析,普元软件技术（上海）有限公司系统需求规格说明书模板,设计文档,信息与软件工程学院,18,主要任务,核心任务：将系统的功能需求分配给软件结构，形成软件的系统结构，并完成表达 体系架构设计 现状：对软件结构的组成要素和描述还没有统一规范，主要依赖于设计者的知识、经验和技巧 现状：人们对同一设计方法的理解和表达差别很大，所使用的符号体系、约定和流行的术语概念缺乏严格和一致性、系统性，没有形成一般性指导 目标：研究和建立形式化、规范化的描述方法是软件界的一项重要课题（如UML）,信息与软件工程学院,19,结构化设计表
6、述：分层,信息与软件工程学院,20,SD表述：流程图,信息与软件工程学院,21,SD 表述：IPO,信息与软件工程学院,22,案例分析,虎溪校区后勤管理系统 概要设计说明书,信息与软件工程学院,23,面向对象设计表述：四个主要部分,问题域部分：根据需求分析中对问题域的描述，针对实现要求进行必要的整补和调整。其重点是：重用类设计、组合问题域专用类、调整继承的支持级别、提供数据管理部分以及增加底层细节。 人机交互部分设计：突出人如何命令系统、系统如何向用户提交信息。尤其对非专业用户如何提交信息。 任务管理部分设计：要点是识别并设计任务，加上包含在每个任务中的服务。 设计管理部分设计：主要是为了隔离
7、数据管理方案对系统设计表达的影响。设计既包含数据存放方法的设计，也包含相应服务的设计。,信息与软件工程学院,24,OOD表述：体系结构设计补充,问题域部分：选择典型的系统结构 模型/视图/控制器（MVC）框架结构。,信息与软件工程学院,25,OOD表述：继承机制,信息与软件工程学院,26,OOD表述：类图（虚拟设备）,信息与软件工程学院,27,OOD表述：时序图（指纹识别）,信息与软件工程学院,28,案例分析,金审工程应用系统-工程管理软件系统详细设计说明书,编程接口文档,信息与软件工程学院,30,什么是编程接口,API：应用编程接口，是软件系统不同组成部分衔接的约定；是软件设计的核心之一 实
8、现层面：接口是方法定义和常量值的集合。 设计层面： - 是功能定义的集合 - 是OO中最抽象的元素 - 是设计软件、构建软件架构的基本要素,信息与软件工程学院,31,为什么要使用编程接口,标识系统中的对象 定义组件应实现的功能 定义组件之间交互的规则 对OO设计，定义多态 接口的副产品,信息与软件工程学院,32,何时使用编程接口,构建软件框架 分离功能定义和功能实现 降低组件之间的耦合度,信息与软件工程学院,33,编程接口的作用,使系统的职责得到合理划分 可以降低系统各部分的相互依赖，提高组成单元的内聚性 降低组成单元间的耦合程度，从而提高系统的维护性和扩展性,信息与软件工程学院,34,如何使用编程接口,接口的典型应用形式,信息与软件工程学院,35,不用编程接口的问题,难以进行软件架构的设计 对象之间紧密耦合 软件可扩展性差 开发人员之间难以合作 随着开发深入，编程工作陷入泥沼,信息与软件工程学院,36,编程接口设计文档,对系统中所涉及的所有编程接口的说明,统一编程接口,信息与软件工程学院,37,案例分析,LK9000编程接口说明书,信息与软件工程学院,38,谢谢!,
