《软件文档写作》PPT课件

《《软件文档写作》PPT课件》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、第3章软件文档写作为什么需要软件文档？文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档……软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。软件文档写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。文档——某种数

2、据媒体和其中所记录的数据。文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系统，提供关于未来改进和重新实施所需的信息，在开发人员、维护人员、管理人员、用户与计算机之间起着重要的桥梁作用。计算机软件用户桥梁作用软件文档与使用者的关系软件开发中产生的各类文档面向不同的用户，而软件用户应该得到的文档也在商业合同中有明确规定。软件文档的使用对象开发人员维护人员管理人员用户可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书测试计划测试分析报告设计说明书测试分析报告模

3、块开发卷宗可行性研究报告项目开发计划模块开发卷宗开发进度月报项目开发总结报告用户手册操作手册软件文档编制与软件生存期的关系软件文档的编制是随着软件生存期各个阶段工作的开展而适时进行的。其中，有的仅反映某一阶段的工作，有的则需要跨越多个阶段的工作。如下表：可行性研究与计划需求分析软件设计编码与单元测试集成测试运行与维护可行性研究报告√项目开发计划√√软件需求说明书√数据要求说明书√测试计划√√概要设计说明书√详细设计说明书√数据库设计说明书√模块开发卷宗√√用户手册√√√操作手册√√测试分析报告√开发进度月报√√√√√项目总结报告√维护和修改建议√软件文档最终需要回答读者

4、关心的下列问题：1.为什么要开发、维护或修改这个软件？(Why)2.工作目标要满足哪些需求？(What)3.需求应如何实现？(How)4.开发、维护或修改的工作应由谁来完成？(Who)5.开发工作的时间如何安排？(When)6.开发工作在什么环境中实现，所需信息从何而来？(Where)为什么(Why)做什么(What)怎么做(How)谁来做(Who)何时做(When)何处做(Where)可行性研究报告√√项目开发计划√√√软件需求说明书√√数据要求说明书√√测试计划√√√概要设计说明书√详细设计说明书√数据库设计说明书√模块开发卷宗√用户手册√操作手册√测试分析报告√开

5、发进度月报√√项目总结报告√维护和修改建议√√√√√软件文档的涉众软件文档涉众主要有以下几类：开发人员、维护人员、管理人员、营销人员和用户。具体的，上述各类涉众又可以再细分，如开发人员可以细分为系统定义和分析工程师、系统架构师、系统设计师、代码工程师、系统集成工程师、测试工程师……有不少软件文档的涉众，既是文档涉众，又是文档的编制者。如系统构架师是系统需求规格说明书的涉众，但同时他自己的工作成果又是通过编制系统构架文档来进行传递。我们这里所说的软件文档涉众，是指那些对某一类或某种软件文档有特殊需求和期望的涉众。下表是各类文档涉众以及他们需要的文档类型(部分)：开发人员维

6、护人员管理人员营销人员用户可行性研究报告√√√项目开发计划√√√软件需求说明书√√数据要求说明书√测试计划√√概要设计说明书√√详细设计说明书√√数据库设计说明书√√模块开发卷宗√√用户手册√√操作手册√√测试分析报告√√开发进度月报√项目总结报告√维护和修改建议√产品市场宣传资料√√√讨论题1.你现在是否明确，为什么需要软件文挡？2.你能用自己的语言描述清楚什么是软件文挡，以及它的作用、地位和涉众吗？对文档编制的质量要求1.针对性编档前即能根据涉众对象，按不同文档类型、不同涉众层次、不同分发策略，确定编档目的、目标、标准、方案、计划和资源。2.精确性文档行文应十分确切

7、、一致，没有多义、矛盾等现象。3.清晰性文档力求简洁，表述清晰，如有可能，则配以适当图表，以增强可阅读性。4.完整性任何文档都是完整的、独立的，是自成体系的。5.灵活性不同软件项目的规模和复杂程度有着许多实际差别，不能一样看待。应根据具体的软件开发项目，决定编制的文档种类。当所开发的软件系统非常大时，一种文档可以分成几卷编写。应根据任务的规模、复杂性、项目负责人对该软件的开发过程及运行环境所需详细程度的判断，确定文档的详细程度。对国标GB8567—88《计算机软件产品开发文件编制指南》所建议的所有条款都可以扩展，进一步细分，以适应需要；反