软件文档基础知识概述

软件文档写作

SoftwareDocumentComposition主讲：金波E-mail:1第一页，共十五页。教材

教材：软件编档导论 清华大学出版社金波编著

参考资料：

计算机软件工程标准(文档部分GB/T8567-1988、GB/T9385-1988)

国家标准汇编中国标准出版社2第二页，共十五页。课程学时分配和评分标准课时分配：每周2+2，共8周+1周最后一周考试(考查)课后作业仅供参考可通过e-mail递交，不限时，不记分考试方法：开卷评分标准：期末考试(60%)＋课程设计(40%)＝总评100%3第三页，共十五页。软件文档写作课程设计项目HomeDesignandImprovementSystem 课程设计项目是若干模拟情景题目。要求：每组不超过6人，设组长一名；组长负责：组织、分工、安排进度等；组长奖罚：引起过半数组员不满者，改选；带领全组顺利完成任务者，总评+5。目的：通过课程设计，实际体验软件工程各阶段的主要工作，特别注意吸取教训；学会与他人合作，培养团队精神。因此，单干户将得不到成绩。4第四页，共十五页。工作内容⑴问题定义 （书面）⑵可行性分析报告 （书面）⑶项目开发计划 （书面）⑷需求规格说明书 （书面）⑸总体设计报告 （书面）⑹系统测试计划 （书面）⑺项目验收方案 （书面）

要求：根据软件工程技术和项目管理理念，在组内合理分工，协同工作。5第五页，共十五页。第一章软件文档概念

1.1为什么需要软件文档？

文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档……软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。观点：“如果不记下来，它就并不存在”。正如老子在《道德经》中所述：鱼不可脱于渊，国之利器不可以示人。6第六页，共十五页。1.2软件文档的定义

软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。文档——某种数据媒体和其中所记录的数据。文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、用户与计算机之间起着重要的桥梁作用。维护人员管理人员计算机软件用户桥梁作用开发人员7第七页，共十五页。1.3文档的作用

软件文档在产品开发过程中具有十分重要的桥梁作用，主要反映在以下几个方面：1.项目管理的依据文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2.技术交流的语言项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3.项目质量保证文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。8第八页，共十五页。4.支持培训与维护合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5.支持软件维护软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6.记载软件历史软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。9第九页，共十五页。1.4软件文档的分类国家标准局在1988年1月颁布了《计算机软件开发规范》和《计算机软件产品开发文件编制指南》，作为软件开发和文档编制工作的准则和规程。基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。软件文档开发文档用户文档管理文档可行性研究报告项目开发计划软件需求说明书数据库设计说明书概要设计说明书详细设计说明书用户手册操作手册软件需求说明书数据要求说明书项目开发计划模块开发卷宗开发进度月报测试计划测试分析报告项目开发总结报告10第十页，共十五页。1.5软件文档与使用者的关系

软件开发中产生的各类文档面向不同的用户，而软件用户应该得到的文档也在商业合同中有明确规定。软件文档的使用对象开发人员维护人员管理人员用户可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书测试计划测试分析报告设计说明书测试分析报告模块开发卷宗可行性研究报告项目开发计划模块开发卷宗开发进度月报项目开发总结报告用户手册操作手册11第十一页，共十五页。1.6软件文档编制与软件生存期的关系软件文档的编制是随着软件生存期各个阶段工作的开展而适时进行的。其中，有的仅反映某一阶段的工作，有的则需要跨越多个阶段的工作。可行性研究与计划需求分析软件设计编码与单元测试集成与测试运行与维护可行性研究报告√项目开发计划√√软件需求说明书√数据要求说明书√测试计划√√概要设计说明书√详细设计说明书√数据库设计说明书√模块开发卷宗√√用户手册√√√操作手册√√测试分析报告√开发进度月报√√√√√项目总结报告√维护和修改建议√12第十二页，共十五页。软件文档最终需要回答读者关心的下列问题：1.为什么要开发、维护或修改这个软件？(Why)2.工作目标要满足哪些需求？(What)3.需求应如何实现？(How)4.开发、维护或修改的工作应由谁来完成？(Who)5.开发工作的时间如何安排？(When)6.开发工作在什么环境中实现，所需信息从何而来？(Where)13第十三页，共十五页。为什么(Why)做什么(What)怎么做(How)谁来做(Who)何时做(When)何处做(Where)可行性研究报告√√项目开发计划√√√软件需求说明书√√数据要求说明书√√测试计划√√√概要设计说明书√详细设计说明书√数据库设计说明书√模块开发卷宗√用户手册√操作手册√测试分析报告√开发进度月报√√项目总结报告√维护和修改建议√√√√√14第十四页，共十五页。内容总结软件文档写作

SoftwareDocumentComposition。软件文档写作

SoftwareDocumentComposition。计算机软件工程标准(文档部分GB/T8567-1988、GB/T9385-1988)。课时分配：每周2+2，共8周+1周。可通过e-mail递