《IT工程师职业基础》第五章 大学生职业生涯规划课程lecture-8开发类文档写作.ppt

* 什么是编程接口 API：应用编程接口，是软件系统不同组成部分衔接的约定；是软件设计的核心之一 实现层面：接口是方法定义和常量值的集合。 设计层面： - 是功能定义的集合 - 是OO中最抽象的元素 - 是设计软件、构建软件架构的基本要素 * 为什么要使用编程接口 标识系统中的对象 定义组件应实现的功能 定义组件之间交互的规则 对OO设计，定义多态 —— 接口的副产品 * 何时使用编程接口 构建软件框架 分离功能定义和功能实现 降低组件之间的耦合度 * 编程接口的作用 使系统的职责得到合理划分 可以降低系统各部分的相互依赖，提高组成单元的内聚性 降低组成单元间的耦合程度，从而提高系统的维护性和扩展性 * 如何使用编程接口 接口的典型应用形式 * 不用编程接口的问题 难以进行软件架构的设计 对象之间紧密耦合 软件可扩展性差 开发人员之间难以合作 随着开发深入，编程工作陷入泥沼 * 编程接口设计文档 对系统中所涉及的所有编程接口的说明 统一编程接口 * * * * 3. 软件需求文档的编制要求 (1) SRS应由开发者和用户双方联合起草 SRS是开发者和用户共同确认系统做什么的基础。 (2) 逐步对SRS进行改进 SRS的改变，是开发者和用户双方对系统做什么的认识逐步一致过程的必然。 (3) SRS的编制工具 SRS的编制一般多采用自然语言，但自然语言不易精确。例如，同一词汇经由文档的多个编制者在多处出现，而这一词汇又涉及系统的实体和许多活动，因此，就有必要对此加以验证，这就需要使用适当的工具。 另外，需求文档的形式化表达、制图、制表等，也都需要适当的工具来辅助完成。 4. 软件需求文档的表达方法 软件需求的表达可以有多种方法。常见的方法主要有：输入、输出说明；使用代表性例子；用规范化的模型。 (1) 输入、输出说明 即用输入输出序列来描述一个软件产品所要求的特性。根据被描述软件的性质，至少有3种不同的途径： a. 着重说明输出。如报表系统。通常这类系统主要在数据文卷上操作； b. 着重说明输入/输出特性。这类系统关注的是在当前的输入上操作； c. 另有一些系统要求记忆状态。如根据本次输入和上次输入进行应答。其行为有如有限状态机。在此情况下，既要关注输入输出对，也要关注这些输入输出对的次序。 * (2) 使用典型的例子 即用典型例子来说明要求的特性。 如某同学身份证号码：33 01 01001 X 省 地 县 出 居性 校 份 区 域 生 住别 验 识 识 识 年 区码 码 别 别 别 月 顺 码 码 码 日 序 码 本例中，就使用一个具体的身份证编码例子，说明了身份证编码的方法。 (3) 应用模型 模型是表达复杂需求有效和精确的方法。常用的通用模型主要有3种：数学模型、功能模型和计时模型。 对于一些特殊的应用，还可以根据需要，应用一些特别有用的模型。如工资单系统可以使用专门的表格。 * 5. 软件需求文档的注释 在软件的所有需求中，必须从SRS中识别或标注出基本或关键的部分。这些工作可以通过对需求文档的注释完成。 完成需求注释时，可以着重考虑以下几个问题： - 稳定性。如采用稳定性量纲，来突出需求的稳定性。 - 必要性等级。即将需求分成必须保证级、期望级和任选级。 - 注意事项。即在需求注释前，须彻底理解注释的实质含义。 6. 软件需求文档的表达重点 SRS的基本点是，它必须说明由软件获得的结果，而不少手段。因此，SRS必须描述的基本问题是：功能、性能、限制、属性、外部接口。 7. 软件需求表达的常见问题 常见的问题一般多是将设计或项目的需求写入SRS中去。因此要避免以下2个问题的发生：在SRS中嵌入设计说明、在SRS中嵌入项目要求。因为，SRS中只应提供软件本身的需求。 设计文档 * 主要任务 核心任务：将系统的功能需求分配给软件结构，形成软件的系统结构，并完成表达 —— 体系架构设计 现状：对软件结构的组成要素和描述还没有统一规范，主要依赖于设计者的知识、经验和技巧 现状：人们对同一设计方法的理解和表达差别很大，所使用的符号