软件文档写作-开发文档.pptVIP

* 软件开发文档 1 开发文档概述 开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细设计描述(程序逻辑、程序间相互关系、数据格式和存储等)。 软件开发文档的作用： 1. 记录生成软件需求、设计、编码和测试的详细规定和说明，是软件开发过程所有阶段之间的通信工具； 2. 描述开发小组的职责。通过规定开发过程的角色，来定义做什么、如何做和何时做； 3. 用作检验点而允许管理者评定开发进度和质量； 4. 形成维护人员所要求的基本的软件支持文档； 5. 记录软件开发的历史。 基本的软件开发文档主要有： —— 可行性研究和项目任务书 —— 需求规格说明 —— 功能规格说明 —— 设计规格说明，包括程序和数据规格说明 —— 开发计划 —— 软件集成和测试计划 —— 质量保证计划、标准、进度 —— 安全和测试信息 2 可行性研究报告 在软件开发的第一阶段，需要完成的可行性研究与项目计划任务，其主要工作是了解用户需求和现实环境，研究并论证项目的可行性，提出系统方案，制定初步的项目开发计划。可行性研究报告是这一阶段工作成果的主要标志之一。 在《计算机软件产品开发文档编制指南》中指出，可行性研究报告的编制目的是：“说明该软件开发项目的实现在技术上、经济上和社会条件上的可行性；评述为合理地达到目标可能选择的各种方案；说明并论证所选定的方案。” 1. 可行性研究报告的内容 对于确定的问题，判定能否解决，是否值得解决，是可行性研究的根本任务。因此，可以按以下内容组织可行性研究报告： (1) 陈述开发目的、要求和限制条件，表达可行性研究的前提条件。 (2) 对现有系统的描述，进而阐述系统开发的意义和必要性。 (3) 提出若干新系统的建议方案，并依次进行技术、经济和社会可行性分析 (4) 在比较多个方案的基础上，得出可行性研究的结论。 2. 可行性研究报告的要求 软件的开发首先要确切定义用户要求解决的问题，即确定要解决问题的性质、目标和规模。对此，可行性分析人员对所要解决问题的理解是否正确十分关键，因为这决定了开发工作的方向。 具体，可行性研究报告的要求如下： (1) 阐明目标软件的基本要求 ? 功能 ? 性能 ? 输出(如报告、文档或数据，输出项特征，如用途、产生频度、接口及方法对象) ? 输入(包括数据来源、类型、数量、数据的组织以及提供的频度) ? 处理流程和数据流程(用图表表示最基本的部分，并辅之以文字说明) ? 安全和保密方面的要求 ? 与本系统相关联的其他系统 ? 完成期限 (2) 说明所建议系统的主要开发目标 ? 人力与设备费用的减少 ? 处理速度的提高 ? 控制精度或生产能力的提高 ? 管理信息服务的改进 ? 自动决策系统的改进 ? 人员利用率的改进 (3) 说明在该项开发中给出的条件、假定和所受到的限制 ? 所建议系统的运行寿命的最小值 ? 进行系统方案选择比较的时间 ? 经费、投资方面的来源和限制 ? 法律和政策方面的限制 ? 硬件、软件、运行环境和开发环境方面的条件和限制 ? 可利用的信息和资源 ? 系统投入使用的最晚时间 (4) 说明进行可行性研究的方法和评价尺度 ? 说明该项可行性研究的进行方法，所建议的系统的评价方法。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等 ? 说明对系统进行评价时所使用的主要尺度。如费用、各项功能的优先次序、开发时间的长短及使用中的难易程度等 (5) 对现有系统的分析 ? 现有系统是新系统将来的取代对象，也是新系统的参照对象。对现有系统的分析是为了阐明开发新系统的必要性，同时，也是导出新系统的方案的出发点 3. 可行性研究报告的描述方法 可行性研究报告的内容可以采用文字、图形或两者相结合的方式描述。 除了文字描述以外，对于那些无法或难以用文字描述的内容，以及那些使用图形描述可以有利于阅读和理解的内容，可以采用图形的方式描述。 可行性研究报告描述的图形工具主要有数据流图、系统流程图。GB/T1526-1989对这两种图形工具的使用进行了具体规定。 [项目名称] 可行性研究报告 拟 制 人______________ 审 核 人______________ 批 准 人______________ [200 年 月 日] 可行性研究报告模板的例子： 1.引言 1.1编写目的 1.2背景 1.3定义 1.4参考资料 2.可行性研究的前提 2.1要求 2.2目标 2.3条件、假定和限制 2.4