软件文档写作的考试的重点
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
甘特图具有简单、醒目和便于编制等特点，在企业管理工作
中被广泛应用。甘特图按反映的内容不同，可分为计划图表、负荷图
表、机器闲置图表、人员闲置图表和进度表等五种形式。
甘特图的优点
图形化概要，通用技术，易于理解； 中小型项目一般不超过30项活动；
有专业软件支持，无须担心复杂计算和分析。
活动网络图
易。 优点 1． 使用表示结构优化控制结构的PAD符号所设计出来的程序必 然是程序化程序 2． PAD图所描述的程序结构十分清晰。图中最左边的竖线是程 序的主线，即第一层控制结构。随着程序层次的增加，PAD图逐渐向 右延伸，每增加一个层次，图形向右扩展一条竖线。PAD图中竖线的 总条数就是程序的层次数； 3． 用PAD图表现程序逻辑，易读、易懂、易记。PAD图是二维 数型结构的图形，程序从图中最左边上端的结点开始执行，自上而 下，从左到右顺序执行； 4． 很容易将PDA图转换成高级程序语言源程序，这种转换可由 软件工具自动完成，从而可省去人工编码的工作，有利于提高软件可 靠性和软件生产率。 5． 既可用于表示程序逻辑，也可用于描述数据结构 6． PAD图的符号支持自顶向下、逐步求精方法的使用。开始时 设计者可以定义一个抽象程序，随着设计工作的深入而使用“def”符号 逐步增加细节，直至完成详细设计。 PAD图是面向高级程序设计语言的，为FORTRAN,COBOL和 PASCAL等每种常用的高级程序设计语言都提供了一整套相应的图形 符号。由于每种控制语句都有一个图形符号与之对应，显然将PAD图 转换成与之对应的高级语言程序比较容易。
何在不同的情况下正确使用它。 软件测试的目的：为了保证软件产品的最终质量，在软件开发的过程 中，对软件产品进行质量控制。 .ISO 9000标准的主导思想： 其一是控制的思想即对产品形成的全过 程--从采购原材料、加工制造到最终产品的销售、售后服务进行控制。 任何一件事物都是由过程组成的，只要对产品形成的全过程进行控制并 达到过程质量要求，最终产品的质量就有了保证。其二是预防的思想。 通过对产品形成的全过程进行控制以及建立并有效运行自我完善机制达 到预防不合格，从根本上减少或消除不合格品。
甘特图（Gantt chart ）又叫横道图、条状图(Bar chart)。它是以图 示的方式通过活动列表和时间刻度形象地表示出任何特定项目的活动顺
序与持续时间。
甘特图包含以下三个含义： 1、以图形或表格的形式显示活动； 2、现在是一种通用的显示进度的方法； 3、构造时应包括实际日历天和持续时间，并且不要将周末和节假日算在进度之内。
如果能够符合以上几点基本要求的那么可以考虑准入到接口测
试的阶段。同时结合在早期设计阶段敲定的一些其他项目相关的标准， 最终决定是否投入资源全面开展接口测试
PAD是问题分析图（Problem Analysis Diagram）的英文缩写，自 1973年由日本日立公司发明以来，已经得到一定程度的推广。它用二 维数形结构的图表示程序的控制流，将这种图转换为程序代码比较容
PAD是一种程序结构可见性好、结构唯一、易于编制、易于检查 和易于修改的详细设计表现方法。用PAD可以消除软件开发过程中设 计与制作的分离，也可消除制作过程中的“属人性”。虽然目前仍需要 由人来编制程序，一旦开发的PAD编程自动化系统实现的话，计算机 就能从PAD自动编程，到那时程序逻辑就是软件开发过程中人工制作 的最终产品。显然在开发时间上大大节省，开发质量上将会大大提 高。
活动网络图在最初的N7工具中称为箭头图，BHale Waihona Puke Baiduassard给它重命名，以
包含建立网络活动模型的其他方式。 这个工具基本上是Program Evaluation and Review Technique(PERT)和
Critical Path Method(CPM)的组合。PERT和CPM是为操作研究而开发 的，是项目管理的两个重要领域。在项目管理的许多优秀图书中都介绍 了这个主题[xxxvii]。活动网络图还包括其他网络图，如节点图、节点 上的活动图(AON)和过程图(PDM)。这个工具用于给熟悉的复杂任务规 划最适宜的时间表[xxxviii]。
认识元宵 做花灯 挂花灯 挂 花 灯
吃元宵 花灯 元宵节的来历 亲子做花灯 收集材料 猜灯谜
元宵主题活动
软件工程标准的层次：国际标准、国家标准、行业标准、企业规范、行 业规范。 在中国的软件标准中《计算机软件文档编制规范（Gb/T8567—2006）》 产生的14种文档： 可行性研究报告、项目开发计划、软件需求规格说明书、数据要求说明 书、概要设计说明书、详细设计说明书、数据库设计说明书、用户手 册、操作手册、模块开发卷宗、测试计划、测试分析报告、、开发进度 月报、项目开发总结报告。 软件文档的编写原则：1.应适应文档的读者2.应有必要的重复性3.应具 有一定的灵活性。 可行性研究的任务：经济可行性、技术可行性、社会因素方面的可行性 （包括法律可行性和使用可行性）、方案的选择 可行性研究的目的：就是用最小的代码在尽可能短的时间内确定问题是 否能够解决。 用户手册的目的：使用非专业术语，充分地描述该软件的功能和基本的 使用方法，使用户（和潜在用户）能够通过手册了解软件的用途以及如
接口的类型：3.1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 3.2外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系 统与各支持软件之间的接口关系。 3.3内部接口 说明本系统之内的各个系统元素之间的接口的安排。
接口测试的一般准则：
1、 明确的需求文档和uc 明确的prd和uc可以使接口测试人员充分了解系统的功能特点，如 果系统的功能都不清楚，那样的测试是十分危险的。 2、 系统设计已基本稳定，频繁变动的接口不多余10% 稳定的系统设计减少接口测试人员无效的工作，一个频繁变更的系 统设计往往会使测试人员对系统产生误解和迷惑，进而导致错误的用例 和测试代码 3、 详尽的系统对外接口说明文档 确保接口测试人员以及后续维护人员对主要测试目标的正确的理解 和认识，能够及早地进行相应的用例设计，避免因为文档不清，口头交 流带来的诸多问题。
软件文档的作用：1.管理依据：在软件开发过程中，管理者必须了解开 发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了 项目的可见性。开发文档规定若干个检查点和进度表，使管理者可以评 定项目的进度，如果开发文档有遗漏、不完善或内容陈旧，则管理者将 失去跟踪和控制项目的重要依据。2.任务之间联系的凭证：大多数软件 开发项目通常被划分成若干个任务，并由不同的小组去完成。而这些小 组人员的相互联系是通过文档资料的复制、分发和引用而实现的。因此 任务间的联系是文档的一个重要功能。3.质量保证：提供软件文档可满 足质量保证人员和审查人员完成他们工作的需要。4.培训与参考：软件 文档的另一个功能是使用系统管理员、操作员、用户、管理者和其他人 员了解系统如何工作，以及为了达到这些人员各自的目的，应该如何使 用用户。5.软件维护与支持：维护人员需要软件系统的详细说明以帮助 他们熟悉系统，找出并修正错误，改进系统以系统以适应用户需求的变 化或适应系统环境的变化。6.历史档案：软件文档可用做未来项目的一 种资源。通常文档记载系统的开发历史，可使有关系统结构的基本思想 为以后的项目所利用。 软件工程标准化的意义：1.提高软件的可靠性、可维护性和可移植性。 2.提高软件的生产率，提高软件人员的技术水平。3.提高软件人员之间 的通信效率，减少差错和误解。4.有利于软件管理。5.有利于降低软件 产品的成本和运行维护成本。6.有利于缩短软件开发周期。
中被广泛应用。甘特图按反映的内容不同，可分为计划图表、负荷图
表、机器闲置图表、人员闲置图表和进度表等五种形式。
甘特图的优点
图形化概要，通用技术，易于理解； 中小型项目一般不超过30项活动；
有专业软件支持，无须担心复杂计算和分析。
活动网络图
易。 优点 1． 使用表示结构优化控制结构的PAD符号所设计出来的程序必 然是程序化程序 2． PAD图所描述的程序结构十分清晰。图中最左边的竖线是程 序的主线，即第一层控制结构。随着程序层次的增加，PAD图逐渐向 右延伸，每增加一个层次，图形向右扩展一条竖线。PAD图中竖线的 总条数就是程序的层次数； 3． 用PAD图表现程序逻辑，易读、易懂、易记。PAD图是二维 数型结构的图形，程序从图中最左边上端的结点开始执行，自上而 下，从左到右顺序执行； 4． 很容易将PDA图转换成高级程序语言源程序，这种转换可由 软件工具自动完成，从而可省去人工编码的工作，有利于提高软件可 靠性和软件生产率。 5． 既可用于表示程序逻辑，也可用于描述数据结构 6． PAD图的符号支持自顶向下、逐步求精方法的使用。开始时 设计者可以定义一个抽象程序，随着设计工作的深入而使用“def”符号 逐步增加细节，直至完成详细设计。 PAD图是面向高级程序设计语言的，为FORTRAN,COBOL和 PASCAL等每种常用的高级程序设计语言都提供了一整套相应的图形 符号。由于每种控制语句都有一个图形符号与之对应，显然将PAD图 转换成与之对应的高级语言程序比较容易。
何在不同的情况下正确使用它。 软件测试的目的：为了保证软件产品的最终质量，在软件开发的过程 中，对软件产品进行质量控制。 .ISO 9000标准的主导思想： 其一是控制的思想即对产品形成的全过 程--从采购原材料、加工制造到最终产品的销售、售后服务进行控制。 任何一件事物都是由过程组成的，只要对产品形成的全过程进行控制并 达到过程质量要求，最终产品的质量就有了保证。其二是预防的思想。 通过对产品形成的全过程进行控制以及建立并有效运行自我完善机制达 到预防不合格，从根本上减少或消除不合格品。
甘特图（Gantt chart ）又叫横道图、条状图(Bar chart)。它是以图 示的方式通过活动列表和时间刻度形象地表示出任何特定项目的活动顺
序与持续时间。
甘特图包含以下三个含义： 1、以图形或表格的形式显示活动； 2、现在是一种通用的显示进度的方法； 3、构造时应包括实际日历天和持续时间，并且不要将周末和节假日算在进度之内。
如果能够符合以上几点基本要求的那么可以考虑准入到接口测
试的阶段。同时结合在早期设计阶段敲定的一些其他项目相关的标准， 最终决定是否投入资源全面开展接口测试
PAD是问题分析图（Problem Analysis Diagram）的英文缩写，自 1973年由日本日立公司发明以来，已经得到一定程度的推广。它用二 维数形结构的图表示程序的控制流，将这种图转换为程序代码比较容
PAD是一种程序结构可见性好、结构唯一、易于编制、易于检查 和易于修改的详细设计表现方法。用PAD可以消除软件开发过程中设 计与制作的分离，也可消除制作过程中的“属人性”。虽然目前仍需要 由人来编制程序，一旦开发的PAD编程自动化系统实现的话，计算机 就能从PAD自动编程，到那时程序逻辑就是软件开发过程中人工制作 的最终产品。显然在开发时间上大大节省，开发质量上将会大大提 高。
活动网络图在最初的N7工具中称为箭头图，BHale Waihona Puke Baiduassard给它重命名，以
包含建立网络活动模型的其他方式。 这个工具基本上是Program Evaluation and Review Technique(PERT)和
Critical Path Method(CPM)的组合。PERT和CPM是为操作研究而开发 的，是项目管理的两个重要领域。在项目管理的许多优秀图书中都介绍 了这个主题[xxxvii]。活动网络图还包括其他网络图，如节点图、节点 上的活动图(AON)和过程图(PDM)。这个工具用于给熟悉的复杂任务规 划最适宜的时间表[xxxviii]。
认识元宵 做花灯 挂花灯 挂 花 灯
吃元宵 花灯 元宵节的来历 亲子做花灯 收集材料 猜灯谜
元宵主题活动
软件工程标准的层次：国际标准、国家标准、行业标准、企业规范、行 业规范。 在中国的软件标准中《计算机软件文档编制规范（Gb/T8567—2006）》 产生的14种文档： 可行性研究报告、项目开发计划、软件需求规格说明书、数据要求说明 书、概要设计说明书、详细设计说明书、数据库设计说明书、用户手 册、操作手册、模块开发卷宗、测试计划、测试分析报告、、开发进度 月报、项目开发总结报告。 软件文档的编写原则：1.应适应文档的读者2.应有必要的重复性3.应具 有一定的灵活性。 可行性研究的任务：经济可行性、技术可行性、社会因素方面的可行性 （包括法律可行性和使用可行性）、方案的选择 可行性研究的目的：就是用最小的代码在尽可能短的时间内确定问题是 否能够解决。 用户手册的目的：使用非专业术语，充分地描述该软件的功能和基本的 使用方法，使用户（和潜在用户）能够通过手册了解软件的用途以及如
接口的类型：3.1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 3.2外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系 统与各支持软件之间的接口关系。 3.3内部接口 说明本系统之内的各个系统元素之间的接口的安排。
接口测试的一般准则：
1、 明确的需求文档和uc 明确的prd和uc可以使接口测试人员充分了解系统的功能特点，如 果系统的功能都不清楚，那样的测试是十分危险的。 2、 系统设计已基本稳定，频繁变动的接口不多余10% 稳定的系统设计减少接口测试人员无效的工作，一个频繁变更的系 统设计往往会使测试人员对系统产生误解和迷惑，进而导致错误的用例 和测试代码 3、 详尽的系统对外接口说明文档 确保接口测试人员以及后续维护人员对主要测试目标的正确的理解 和认识，能够及早地进行相应的用例设计，避免因为文档不清，口头交 流带来的诸多问题。
软件文档的作用：1.管理依据：在软件开发过程中，管理者必须了解开 发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了 项目的可见性。开发文档规定若干个检查点和进度表，使管理者可以评 定项目的进度，如果开发文档有遗漏、不完善或内容陈旧，则管理者将 失去跟踪和控制项目的重要依据。2.任务之间联系的凭证：大多数软件 开发项目通常被划分成若干个任务，并由不同的小组去完成。而这些小 组人员的相互联系是通过文档资料的复制、分发和引用而实现的。因此 任务间的联系是文档的一个重要功能。3.质量保证：提供软件文档可满 足质量保证人员和审查人员完成他们工作的需要。4.培训与参考：软件 文档的另一个功能是使用系统管理员、操作员、用户、管理者和其他人 员了解系统如何工作，以及为了达到这些人员各自的目的，应该如何使 用用户。5.软件维护与支持：维护人员需要软件系统的详细说明以帮助 他们熟悉系统，找出并修正错误，改进系统以系统以适应用户需求的变 化或适应系统环境的变化。6.历史档案：软件文档可用做未来项目的一 种资源。通常文档记载系统的开发历史，可使有关系统结构的基本思想 为以后的项目所利用。 软件工程标准化的意义：1.提高软件的可靠性、可维护性和可移植性。 2.提高软件的生产率，提高软件人员的技术水平。3.提高软件人员之间 的通信效率，减少差错和误解。4.有利于软件管理。5.有利于降低软件 产品的成本和运行维护成本。6.有利于缩短软件开发周期。