文档写作01

《软件文档与标准》序论序论软件的概念、特点、分类软件工程的构成、目标、原则软件文档的地位、作用、种类相关标准软件的概念1程序：按事先设计的功能和性能要求执行的指令序列；数据：使程序能正常操纵信息的数据结构；文档：与程序开发、维护和使用有关的图文材料；软件的概念2软件的形式化定义：①能够完成预定功能和性能的可执行指令；②使程序能够进行适当操作信息的数据结构；③描述程序的操作和使用的文档；软件的特点逻辑实体，抽象性；没有明显的制造过程；没有磨损、老化等问题；即没有“浴盆曲线”，但存在退化曲线受计算机系统及操作系统影响；手工开发方式；软件本身是个复杂系统；成本昂贵；涉及到社会因素；软件的分类功能划分：系统软件、支撑软件、应用软件工作方式划分：实时处理软件、分时软件、交互式、批处理服务对象划分：项目软件、产品软件软件的发展软件危机软件开发的进度难以控制，经常出现经费超预算、完成期限一再拖延的现象。软件需求在开发初期不明确，导致矛盾在后期集中暴露，从而对整个开发过程带来灾难性的后果。由于缺乏完整规范的资料，加之软件测试不充分，从而造成软件质量低下，运行中出现大量问题。软件工程的概念NATO会议上给出软件工程的定义：软件工程是为了经济地获得能够在实际机器上高效运行的可靠软件而建立和使用的一系列好的工程化原则。1983年，IEEE（InstituteofElectrical&ElectronicEngineers）给出了一个更为全面的定义：软件工程是研究和应用如何以系统化的、规范的、可度量的方法去开发、运行和维护软件，即把工程化应用到软件上。软件工程三要素软件工程是一种层次化的技术，其中过程、方法和工具是软件工程的三个要素。（1）软件工程必须以有组织的质量保证为基础。（2）软件工程过程是进行一系列有组织的活动，从而能够合理地和及时地开发出计算机软件。过程定义了技术方法的采用、工程产品（包括模型、文档、数据、报告、表格等）的产生、里程碑的建立、质量的保证和变更的管理。（3）软件工程方法为软件开发提供如何做的技术，它涵盖了项目计划、需求分析、系统设计、程序实现、测试与维护等一系列任务。（4）软件工具为过程和方法提供自动的或半自动的支持。CASE集成了软件、硬件和一个存放开发过程信息的软件工程数据库，形成了一个软件工程环境。软件工程的目标1软件工程旨在开发满足用户需要、及时交付、不超过预算和无故障的软件，其主要目标如下：（1）合理预算开发成本，付出较低的开发费用；（2）实现预期的软件功能，达到较好的软件性能，满足用户的需求；（3）提高所开发软件的可维护性，降低维护费用；（4）提高软件开发生产率，及时交付使用。软件工程的目标2可修改性(modifiability)有效性(efficiency)可靠性(reliability)可理解性(understandability)可维护性(maintainability)可重用性(reusability)可适应性(adaptability)可移植性(portability)可追踪性(traceability)可互操作性(interoperability)软件工程的原则11、用分阶段的生命周期计划严格管理2、坚持进行阶段评审3、实行严格的产品控制4、采用现代程序设计技术5、结果应能清楚地审查6、开发小组的人员应该少而精7、承认不断改进软件工程实践的必要性软件工程的原则21.抽象(abstraction2.信息隐藏(informationhiding)3.模块化4.局部化(localization)5.一致性(consistency)6.完全性(completeness)7.可验证性(verifiability)软件文档软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。软件文档的作用开发人员阶段成果与结束标志开发过程的“透明度”增强开发的系统性协调开发，提供维护依据说明软件的安装、修改、运行等信息软件文档的分类软件生存周期与文档阶段文档可行性要求与计划需求分析设计代码编写测试运行与维护可行性研究报告项目开发计划软件需求说明数据要求说明概要设计说明星系设计说明测试计划用户手册操作手册测试分析报告开发进度月报项目开发总结维护修改建议软件文档与用户1哪些需求要被满足，即回答“做什么?”所开发的软件在什么环境中实现以及所需信息从哪里来，即回答“从何处?”某些开发工作的时间如何安排，即回答“何时干?”某些开发(或维护)工作打算由“谁来干?”某些需求是怎么实现的?为什么要进行那些软件开发或维护修改工作?软件文档与用户2所提问题文档什么何处何时谁如何为何可行性研究报告√√项目开发计划√√√软件需求说明√√数据要求说明√√概要设计说明√详细设计说明√测试计划√√√用户手册√操作手册√测试分析报告√开发进度月报√√项目开发总结√维护修改建议√√√软件文档的基本要求及时性完整性准确性规范性机构与标准ISO,ISO/TC97GB,ANSIIEEE,GJB,MIL_SGPD(IBM)CIMSISO9000-3与软件1彻底文档化双方责任需求规格说明开发计划、质量管理测试与验证验收维护与培训ISO9000-3与软件2相关标准