IT工程师职业基础lecture-11

1、第四章第四章 第十一讲第十一讲开发类文档写作开发类文档写作第四章第四章软件文档写作软件文档写作 文档写作概要 软件文档的类型、标准与规范 开发类文档写作 用户类文档写作开发类开发类文档写作文档写作信息与软件工程学院4本节的目的本节的目的 了解开发类技术文档的写作方法与格式 掌握开发类软件文档的写作要点 熟悉常用的开发类文档：可行性分析报告、软件需求规范、软件设计文档、编程接口API、界面设计说明、软件测试报告可行性分析报告可行性分析报告 信息与软件工程学院6概述概述 立项决策前必不可少的关键环节，是在项目建议书获准的基础上，主要对项目市场、技术、财务、工程、经济和环境等方面进行精确系统、完备无

2、遗的分析，完成包括市场和销售、规模和产品、原辅料供应、工艺技术、设备选择、人员组织、实施计划、投资与成本、效益及风险等的计算、论证和评价，选定最佳方案，依此就是否应该投资开发该项目以及如何投资，或就此终止投资还是继续投资开发等给出结论性意见，为投资决策提供科学依据，并作为进一步开展工作的基础。信息与软件工程学院7主要内容主要内容全面深入地进行市场分析、预测对资源开发项目要深入研究确定资源的可利用对资源开发项目要深入研究确定资源的可利用量，资源的自然品质，资源的赋存条件和开发量，资源的自然品质，资源的赋存条件和开发利用价值利用价值深入进行项目建设方案设计，包括：项目的建设规模与产品方案、主要设备

3、方案、环境影响问题、人力资源配置、项目进度计划、所需投资估算、.信息与软件工程学院8案例分析案例分析广东省教育部科技部产学研重大项目家电智能技术的研究及其应用可行性研究报告需求分析文档需求分析文档信息与软件工程学院10需求定义及其包含的内容需求定义及其包含的内容需求是系统的基础，陈述系统做什么，解决陈述系统做什么，解决do what，而不是how to do功能需求功能需求：指系统必须完成的那些事，即系统要完成用户提出的各种功能要求非功能需求非功能需求：指软件必须具备的品质或属性，如可靠性、系统响应时间、容错、可扩展性等设计约束设计约束：指客户提出的一些补充约束说明，如系统必须基于SOA、采用

4、Oracle、必须采用Unix服务器等技术要求。 信息与软件工程学院11什么是需求分析？什么是需求分析？ 目标目标：分析客户的需求是什么（分析原系统功能、存在的问题、对未来系统的期望），全面理解客户的各项要求，准确地表达所接受的客户需求。定义定义：需求分析是获取需求获取需求、表达需求表达需求和验证验证需求需求的过程，最终形成一个客户和开发人员都遵守的规约：软件需求规格说明书。需求规格说明书需求规格说明书：详细记录项目的目标、约束条件、功能需求、非功能需求、接口需求、开发运行环境要求等内容。信息与软件工程学院12需求分析的需求分析的I/O原系统存在问题客户期望需求规格说明需求分析输入处理输出信息

5、与软件工程学院13获取需求与表达需求获取需求与表达需求 获取需求：获取需求：问卷调查、客户访谈 表达需求表达需求：自然语言、用例模型（UML）主执行者系统边界用例箭头信息与软件工程学院14一些基本原则一些基本原则 准则准则1：使用简单的语法：使用简单的语法。例，系统从账户余额中扣除100元 准则准则2：明确地写出：明确地写出“谁控制球谁控制球”：句子的主语（执行者）必须明确 准则准则3：从系统外部描述系统：从系统外部描述系统“系统读取ATM卡和PIN号码，并从帐号余额中扣除一定数量” - 系统内部的角度应改为：“用户插入ATM卡并输入PIN号码”“系统从帐号余额中扣除一定数量”信息与软件工程学

6、院15一些基本原则（二）一些基本原则（二） 准则准则4：显示执行者的意图而不是动作：显示执行者的意图而不是动作修改前：修改前：1）系统要求用户输入名字2）用户输入名字3）系统要求用户输入地址4）用户输入地址5）用户点击“确定”6）系统. 修改后：修改后：1）用户输入名字和地址2）系统信息与软件工程学院16一些基本原则（三）一些基本原则（三） 准则准则5：“确认确认”而不是而不是“检查与否检查与否”修改前：修改前：1）系统检查密码是否正确2）如果密码正确，系统修改后：修改后：1）系统确认密码正确。2）系统信息与软件工程学院17一些基本原则（四）一些基本原则（四） 准则准则6：循环表达：循环表达“

7、循环执行步骤循环执行步骤x到到y，直到条件满足直到条件满足”1）顾客提供帐号或者名字和地址2）系统查出顾客的爱好信息3）用户选择一个商品，并做上购买的标记4）系统将这个商品加入到顾客的“购物车”中 顾客重复步骤3-4，直到顾客指明完成了选购5）顾客购买所有在购物车中的商品信息与软件工程学院18案例分析案例分析基于SOA的软件生产线集成开发平台文档汇编需求规格说明书设计文档设计文档信息与软件工程学院20主要任务主要任务核心任务：将系统的功能需求分配给软件结构，形成软件的系统结构，并完成表达 体系架构设计现状：对软件结构的组成要素和描述还没有统一规范，主要依赖于设计者的知识、经验和技巧现状：人们对

8、同一设计方法的理解和表达差别很大，所使用的符号体系、约定和流行的术语概念缺乏严格和一致性、系统性，没有形成一般性指导目标：研究和建立形式化、规范化的描述方法是软件界的一项重要课题（如UML）信息与软件工程学院21结构化设计表述：分层结构化设计表述：分层信息与软件工程学院22SD表述：流程图表述：流程图信息与软件工程学院23SD 表述：表述：IPO 输入输入处理处理输出输出旧的主文件旧的主文件事务文件事务文件1. 检验主记录检验主记录2. 校验事务记录校验事务记录3. 更新主记录更新主记录有效的主记录有效的主记录有效的事务记录有效的事务记录更新后的主记录更新后的主记录信息与软件工程学院24案例分

9、析案例分析收银员管理系统收银员管理系统概要设计书信息与软件工程学院25面向对象设计表述：四个主要部分面向对象设计表述：四个主要部分问题域部分：问题域部分：根据需求分析中对问题域的描述，针对实现要求进行必要的整补和调整。其重点是：重用类设计、组合问题域专用类、调整继承的支持级别、提供数据管理部分以及增加底层细节。人机交互部分设计：人机交互部分设计：突出人如何命令系统、系统如何向用户提交信息。尤其对非专业用户如何提交信息。任务管理部分设计：任务管理部分设计：要点是识别并设计任务，加上包含在每个任务中的服务。设计管理部分设计：设计管理部分设计：主要是为了隔离数据管理方案对系统设计表达的影响。设计既包

10、含数据存放方法的设计，也包含相应服务的设计。信息与软件工程学院26OOD表述：体系结构设计补充表述：体系结构设计补充问题域部分：问题域部分：选择典型的系统结构选择典型的系统结构 模型模型/视视图图/控制器（控制器（MVC）框架结构。）框架结构。视图视图模型模型控制器控制器信息与软件工程学院27OOD表述：继承机制表述：继承机制AB父类父类子类子类派生派生 继承继承动物动物家禽类家禽类宠物宠物鸡鸡鸭鸭鹅鹅狗狗猫猫信息与软件工程学院28OOD表述：类图（虚拟设备）表述：类图（虚拟设备）ApplicationCanvasDraw( )Line( )Circle( )Rectangle( )TextO

11、ut( )DrawSpaceDraw( )Line( )Circle( )Rectangle( )TextOut( )PrinterDrawSpaceDraw( )Line( )Circle( )Rectangle( )TextOut( )PrinterPrewDrawSpaceDraw( )Line( )Circle( )Rectangle( )TextOut( )ScreenWinDrawSpaceDraw( )Line( )Circle( )Rectangle( )TextOut( )OtherGDI信息与软件工程学院29OOD表述：时序图（指纹识别）表述：时序图（指纹识别）信息与软件工

12、程学院30案例分析案例分析车辆监控平台高层设计说明书编程接口文档编程接口文档信息与软件工程学院32什么是编程接口什么是编程接口 API：应用编程接口，是软件系统不同组成部分衔接的约定；是软件设计的核心之一 实现层面：实现层面：接口是方法定义和常量值的集合。 设计层面：设计层面： - 是功能定义的集合 - 是OO中最抽象的元素 - 是设计软件、构建软件架构的基本要素信息与软件工程学院33为什么要使用编程接口为什么要使用编程接口 标识系统中的对象 定义组件应实现的功能 定义组件之间交互的规则 对OO设计，定义多态 接口的副产品信息与软件工程学院34何时使用编程接口何时使用编程接口 构建软件框架 分离功能定义和功能实现 降低组件之间的耦合度信息与软件工程学院35编程接口的作用编程接口的作用 使系统的职责得到合理划分 可以降低系统各部分的相互依赖，提高组成单元的内聚性 降低组成单元间的耦合程度，从而提高系统的维护性和扩展性信息与软件工程学