软件文档写作01-概述教学文稿.pptVIP

软件文档写作Software Document Composition;教 材;课程目的;课程内容和要求;课程特点;书面作业;实践性环节作业;软件文档写作课程设计项目 Home Design and Improvement System 课程设计项目是若干模拟情景题目 要求：每组6人，设组长一名； 组长负责：组织、分工、安排进度等； 目的：通过课程设计，实际体验软件工程各阶段的主要工作，特别注意吸取教训；学会与他人合作，培养团队精神。;工 作 内 容 ⑴《可行性研究报告》 ⑵《项目开发计划》 ⑶《软件需求说明书》 ⑷《数据要求说明书》 ⑸《概要设计说明书》 ⑹《详细设计说明书》 ⑺《数据库设计说明书》 ⑻《用户手册》 ⑼《操作手册》 ⑽《模块开发卷宗》 ⑾《测试计划》 ⑿《测试分析报告》 ⒀《开发进度月报》 ⒁《开发总结报告》;1.1 为什么需要软件文档？（理解） 1.2 软件文档的定义（了解） 1.3 软件文档的作用（理解、重点） 1.4 软件文档的分类（掌握、重点） 1.5 软件文档与使用者的关系（掌握、重点） 1.6 软件文档编制与软件生存期的关系（理解、难点） ;第一章 软件文档概念;1.2 软件文档的定义 软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。 文档——某种数据媒体和其中所记录的数据。 文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。 文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、用户与计算机之间起着重要的桥梁作用。;1.3 软件文档的作用 软件文档在产品开发过程中具有十分重要的桥梁作用，主要反映在以下几个方面： 1. 项目管理的依据 文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。 2. 技术交流的语言 项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。 3. 项目质量保证 文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。;4. 支持培训与维护 合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。 5. 支持软件维护 软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。 6. 记载软件历史 软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。 良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。;1.4 软件文档的分类 国家标准局在1988年1月颁布了《计算机软件开发规范》和《计算机软件产品开发文件编制指南》，作为软件开发和文档编制工作的准则和规程。 基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。 软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。;开发文档;1.5 软件文档与使用者的关系 软件开发中产生的各类文档面向不同的用户，而软件用户应该得到的文档也在商业合同中有明确规定。;1.6 软件文档编制与软件生存期的关系 软件文档的编制是随着软件生存期各个阶段工作的开展而适时进行的。 其中，有的仅反映某一阶段的工作，有的则需要跨越多个阶段的工作。;; 软件文档最终需要回答读者关心的下列问题： 1. 为什么要开发、维护或修改这个软件？(Why) 2. 工作目标要满足哪些需求？(What) 3. 需求应如何实现？(How) 4. 开发、维护或修改的工作应由谁来完成？(Who) 5. 开发工作的时间如何安排？(When) 6. 开发工作在什么环境中实现，所需信息从何而来？(Where) ;;本章重点;本章作业