软件文档编写Word文档下载推荐.docx

软件文档编写Word文档下载推荐.docx

《软件文档编写Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《软件文档编写Word文档下载推荐.docx（28页珍藏版）》请在冰豆网上搜索。

4.1.1需求分析概述

4.1.2软件需求规格说明书的目的和编写要求

4.1.3软件需求规格说明书的内容要求与编写指南

4.1.4软件需求规格说明书示例

4.2概要设计说明书

4.2.1概要设计概述

4.2.2概要设计说明书的内容要求与编写指南

4.2.3概要设计说明书示例

4.3详细设计说明书

4.3.1详细设计概述

4.3.2详细设计说明书的内容要求和编写指南

4.3.3详细设计说明书示例

实训2

第5章基于面向对象方法的软件需求规格说明书

5.1面向对象的软件需求分析概述

5.2软件需求規格说明书的内容要求与编写指南

5.2.1引言

5.2.2项目概述

5.2.3需求规定

5.3用例说明书的内容及编写要点

5.4基于面向对象方法的软件需求規格说明书示例

实训3

第6章基于面向对象方法的软件设计说明书

6.1面向对象软件设计概述

6.2面向对象的软件设计说明书的内容要求和编写指南

6.2.1类报告

6.2.2用例实现报告

6.2.3设计模型报告

6.3面向对象设计文档的编写示例

实训4

第7章程序代码的文档化

7.1程序代码規范

7.2Doxygen应用基础

7.2.1安装Doxygen

7.2.2设置项目的Doxygen配置文件模板

7.2.3编写正确格式的注释

7.2.4制作说明文件

7.2.5Doxygen使用步骤及范例

实训5

第8章面向对象测试文档

8.1面向对象测试概述

8.1.1面向对象测试的具体任务

8.1.2面向对象测试的步骤

8.2面向对象测试文档

8.2.1测试计划

8.2.2测试用例

8.2.3测试报告

8.3面向对象测试文档的内容要求和编写指南

8.3.1引言

8.3.2项目背景

8.3.3质量目标

8.3.4测试资源

8.3.5测试策略

8.3.6测试计划

实训6

参考文献

第1章

软件工程标准化与软件文档

学习目标

●软件生存周期与软件文档。

●软件文档的作用与分类。

●软件工程标准化的意义和作用。

●软件工程标准的分类方法，软件工程标准的制定与推行过程。

●我国的软件工程标准化工作和相关标准。

软件是指与计算机系统的操作有关的计算机程序及文档的集合。

简单地说,软件包括程序和文档两部分。

计算机程序是指适合于计算机处理的指令序列以及所处理的数据：

软件文档（softwaredocument）是与软件开发、维护和使用有关的文字材料,如技术文档、设计文档、版本说明文档等，文档和程序共同构成了能完成特定功能的计算机软件。

可以说，没有文档的软件，不能称其为软件，更不能成为软件产品。

软件生存周期由计划、开发和运行三个时期组成,每一时期可再细分一些工作阶段。

文档是与软件生存周期紧密关联的。

1.计划时期

可以把计划时期再细分为几个阶段:

（1）问题定义

（2）可行性研究

（3）制订开发计划

2.开发时期

（1）需求分析

确定系统的功能、性能和其他方面的要求:

系统必须做什么?

对所要解决的问题进

行详细定义,这需要软件开发人员和用户共同讨论决定,哪些需求是可以满足的,并加以确切地描述。

编写软件需求说明书、初步用户手册、确认测试计划和数据要求说明书等。

（2）概要设计

根据软件需求说明书的要求,确定系统的事务处理流程,确定软件的总体结构和全局数据结构,并对输入和输出、安全性控制等方面做出全局性规划,从而回答系统应该怎么做才能满足需求规格说明书的规定。

编写软件概要设计说明书。

（3）详细设计

将整个系统分解成若干个子系统或模块,定义子系统或模块间的接口关系,对各子系统进行具体设计定义。

编写软件详细设计说明书,数据库或数据结构设计说明书,组装测试计划。

（4）编码

把软件设计转换成计算机可以接受的程序,即写成以某一程序设计语言表示的源程序清

单。

（5）测试和排错

设法找到程序的潜在错误,并加以修正,以提高软件的正确性和可靠性。

3.运行时期

编写软件问题报告、软件修改报告。

1.2软件文档的作用

1.管理依据

2.任务之间联系的凭证

3.质量保证

4.培训与参考

5.软件维护支持

6.历史档案

一般说来,软件文档可分为以下三种类别:

●开发文档——描述开发过程本身。

●产品文档——描述开发过程的产物。

●管理文档——记录项目管理的信息。

1.3.1开发文档

开发文档是描述软件开发过程,包括软件需求、软件设计、软件测试、保证软件质量的一

类文档,开发文档也包括软件的详细技术描述（程序逻辑、程序间的相互关系、数据格式和存储等）。

开发文档所起的作用可归纳如下:

●它们是软件开发过程中包含的所有阶段之间的通信工具,它们记录生成软件需求、设

计、编码和测试的详细规定和说明。

●它们描述开发小组的职责。

通过规定软件、主题事项、文档编制、质量保证人员以及

包含在开发过程中任何其他事项的角色来定义如何做和何时做。

●它们用作检验点而允许管理者评定开发进度。

如果开发文档丢失、不完整或过时,管

理者将失去跟踪和控制软件项目的一个重要工具。

●它们形成了维护人员所要求的基本的软件支持文档。

而这些支持文档可作为产品文档

的一部分。

●它们记录软件开发的历史。

基本的开发文档是:

●可行性研究和项目任务书。

●软件需求规格说明。

●软件功能规格说明。

●软件设计规格说明,包括程序和数据规格说明。

●开发计划。

●软件集成和测试计划。

●质量保证计划、标准、进度。

●安全和测试信息。

1.3.2产品文档

产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。

产品文档起到如下

作用:

●为使用和运行软件产品的任何人规定培训和参考信息。

●使得那些未参加开发本软件的程序员维护它。

●促进软件产品的市场流通或提高可接受性。

产品文档用于下列类型的读者:

●用户——他们利用软件输入数据、检索信息和解决问题。

●运行者——他们在计算机系统上运行软件。

●维护人员——他们维护、增强或变更软件。

产品文档包括如下内容:

●用于管理者的指南和资料,它们是用来监督软件的使用的。

●宣传资料,用于通告软件产品的可用性并详细说明它的功能、运行环境等。

●一般信息,用来对任何有兴趣的人描述软件产品。

基本的产品文档包括:

培训手册、参考手册和用户指南、软件支持手册、产品手册和信息

广告等。

1.3.3管理文档

1.4软件工程标准化

1.4.1软件工程标准化的意义

软件工程的标准化会给软件开发工作带来许多好处,比如:

●提高软件的可靠性、可维护性和可移植性（这表明软件工程标准化可提高软件产品的质量）。

●提高软件的生产率,提高软件人员的技术水平。

●提高软件人员之间的通信效率,减少差错和误解。

●有利于软件管理。

●有利于降低软件产品的成本和运行维护成本。

●有利于缩短软件开发周期。

1.4.2软件工程标准的层次

（1）国际标准

（2）国家标准

由政府或国家级的机构制定或批准,适用于全国范围的标准,如:

●GB——中国的国家标准，简称“国标”（GB）。

由中国国家标准化管理委员会（我国的最高标准化管理机构）公布并实施。

现已批准了若干个软件工程标准。

●ANSI——美国国家标准学会（AmericanNationalStandardsInstitute）是美国政府认可的国家标准化团体,具有一定权威性，它所颁布的标准均冠以ANSI字样。

●FIPS/NBS（FederalInformationProcessingStandards/NationalBureauofStandards）——国商务部国家标准局联邦信息处理标准。

NBS所公布的标准均冠有FIPS字样。

（3）行业标准

（4）企业规范

（5）行业规范

1.4.3中国的软件标准

1.可行性研究招告

2.项目开发计划

3.软件需求说明书

4.数据要求说明书

5.概要设计说明书

6.详细设计说明书

7.数据库设计说明书

8.用户手册

9.操作手册

10.模块开发卷宗

11.测试计划

12.测试分析报告

13.开发进度月报

14.项目开发总结报告

1.4.4五种常见的国际软件标准

1.IEEE软件工程标准

（1）历史

（2）涵盖范围

（3）目的

（4）组织架构

（5）使用对象

（6）应用领域

第一卷（CustomerandTerminologyStandards，客户与术语之标准）的应用领域如下：

第二卷（ProcessStandards，过程标准）的应用领域如下：

第三卷（ProductStandards，产品标准）的应用领域如下：

第四卷（ResourceandTechniqueStandards，资源与技术标准）的举例如下：

（7）修订频率

2.ISO/IEC/IEEE/EIA12207

（2）历史

ISO/IEC12207共包括了3种型态的软件开发过程：

主要过程、辅助过程和组织过程，其分类层次如下：

1）主要过程（primarylifecycleprocesses）

●获得（acquisition）

●供应（supply）

●开发（development）

●运作（operation）

●维护（maintenance） 

2）辅助过程（supportinglifecycleprocesses）

●文档（documentation）

●配置管理（configurationmanagement）

●质量保证（qualityassurance）

●验证（verification）

●确认（validation）

●联合评审（jointreview）

●审计（audit） 

3）组织过程（organizationallifecycleprocesses）

●管理（management）

●基础建设（infrastructure）

●改善（improvement）

●培训（training） 

●使用对象

（5）应用领域

（6）修订频率

3.SELRecommendedApproach

（2）内容

（6）应用范围

4.SSDMStandardsandProcedures

SSDM标准和规则共分为如下7章，括号中的数字表示每一个章节所包含标准和程序的数目：

●项目管理（33）

●系统工程（3）

●硬件发展（3）

●软件开发（24）

●系统测试与评估（3）

●文件（32）

●标准和规程的建立（3）

5.ISO9000系列标准

结构上，ISO9001:

1994分为下面20种需求，而ISO9000-3:

1997也具有相同的组织架构：

●管理责任（managementresponsibility）

●品质系统（qualitysystem）

●合约审查（contractreview）

●设计管制（designcontrol）

●文件及资料之管制（documentanddatacontrol）

●采购（purchasing）

●客户供应品之管制（controlofcustomer-suppliedproduct）

●产品鉴别与追溯性（productidentificationandtraceability）

●过程管制（processcontrol）

●检验与测试（inspectionandtesting）

●检验、量测与测试设备之管制（controlofinspection,measuringandtestequipment）

●检验与测试状况（inspectionandteststatus）

●不合格品之管制（controlofnonconformingproduct）

●矫正及预防措施（correctiveandpreventiveaction）

●搬运、储存、包装、保存与交货（handling,storage,packaging,preservationanddelivery）

●品质纪录之管制（controlofqualityrecords）

●内部品质稽核（internalqualityaudits）

●教育训练（training）

●服务（Servicing）

●统计技术（Statisticaltechniques）

1.5.1软件文档的编写原则

1.应适应文档的读者

2.应有必要的重复性

3.应具有一定的灵活性

1.5.2文档编写的灵活性

1.文档的种类

（1）应该编制哪几种文档，详细程度如何。

（2）各个文档的编制负责人和进度要求。

（3）审查、批准的负责人和时间进度安排。

（4）在开发时期内，各文档的维护、修改和管理的负责人以及批准手续。

2.文档的详细程度

3.文档的扩展

项目开发计划可能包括以下内容：

●质量保证计划

●配置管理计划

●用户培训计划

●安装实施计划

系统设计说明书可划分成以下内容：

●系统设计说明书

●子系统设计说明书

程序设计说明书可划分成以下内容：

●程序设计说明书

●接口设计说明书

●版本说明

操作手册可划分成以下内容：

●操作手册

●安装实施过程

测试计划可划分成以下内容：

●测试计划

●测试设计说明

●测试规程

●测试用例

测试分析报告可划分成以下内容：

●综合测试报告

●验收测试报告

4.章节的扩张与缩并

5.程序设计的表现形式

6.文档的表现形式

7.文档的其它种类

1.5.3制定文档编制策略

1.文档需要覆盖整个软件生存周期

2.文档应是可管理的

3.文档应适合于它的读者

4.文档的作用应贯穿软件的整个开发过程

5.应当采用并标明文档标准

6.应规定支持工具

1.5.4建立企业的文档标准

1.选择软件生存周期模型

2.规定文档类型和内容

3.确定文档的质量等级

文档的质量可以按文档的形式和列出的要求划分为4级。

①最低限度文档（1级文档）：

1级文档适合开发工作量低于一个人月的开发者自用程序。

该文档应包括程序清单、开发记录、测试数据和程序简介。

②内部文档（2级文档）：

2级文档可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。

除1级文档提供的信息外，2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。

③工作文档（3级文档）：

3级文档适合于由同一单位内若干人联合开发的程序，或可被

其他单位使用的程序。

④正式文档（4级文档）：

4级文档适合那些要正式发行供普通使用的软件产品。

关键性程

序或具有重复管理应用性质（如工资计算）的程序需要4级文档。

4级文档应遵守GB8567-1988的有关规定。

1.5.5制定文档计划

●列出应编写文档的目录

●提示编写文档应参考的标准

●指定文档管理员

●提供编写文档所需要的条件，落实文档编写人员、所需经费以及编写工具等

●明确保证文档质量的方法，为了确保文档内容的正确性、合理性，应采取一定的措施，

如评审、鉴定等。

●绘制进度表，以图表形式列出在软件生存周期各阶段应产生的文档、编制人员、编制日

期、完成日期、评审日期等

1.5.6建立文档管理规程

文档管理规程是关于文档的计划、编写、评审、制作和分发的步骤，这些规程包含审批、质量保证及若干控制点，规定了修改步骤、存储和维护要求以及更新方法。

1.制订文档计划

2.编写文档

●按文档计划规定的文档数量和质量要求编写文档。

●按GB8567-1988或单位制定的标准内容和格式编写相应文档。

●文档用纸的格式由各单位按有关标准规定执行。

●每个文档必须装订成册，并加封面和目录。

●归档用的文档还应有扉页，用于各责任者的签署。

3.文档编号

4.文档评审

（1）评审的内容

（2）需求评审

（3）设计评审

（4）其它评审

●编排方式。

●技术准确度。

●覆盖范围的完整性。

●对读者的适合程度。

●图表设计思想及最终图表（也应接受关于技术准确度、适合程度和完整性的单独评审）。

●在语法、标点及其他行文技巧方面的正确性。

●对格式和别的标准的遵守程度。

（5）评审程序

评审通常采用评审会的方式进行。

其一般步骤如下。

1有软件开发单位负责人、用户代表、开发小组成员、科技管理人员和标准化人员等组成

评审小组，必要时还可邀请外单位的专家参加。

2开会前，由开发单位负责人确定评审的具体内容，并将评审材料发给评审小组成员，

要求做好评审准备。

3由开发单位负责人主持评审会，根据文档编制者对该文档的说明和评审条目，由评审

小组成员进行评议、评审，评审结束时应做出评审结论，评审小组成员应在评审结论上签字。

5.文档的签署

6.文档归档与保管

7.文档维护

1.5.7软件文档的质量要求

●缺乏实践经验，缺乏评价文档质量的标准。

●不重视文档编写工作，或是对文档编写工作的安排不恰当。

高质量的软件文档应具备以下几个方面的特点。

（1）针对性

（2）精确性

（3）清晰性

（4）完整性

（5）灵活性

（6）可追溯性

●与客户和其他项目组的所有往来必须有记录。

●对所有的活动都有一个跟踪落实的过程，比如对所有的审查记录和更改请求都进行标

记，通过跟踪其状态来监督落实情况。

●对所有的活动，包括对文档和代码的更改都会有历史记录。

●记录都是通过定量的数值或者专业工具加以记录，强调以数据说话，比较准确、客观。

第二章

CASE工具与软件文档编写

●CASE工具的意义和作用。

●CASE工具支持下的文档编写

2.1CASE概述

CASE（ComputerAidedSoftwareEngineering，计算机辅助软件工程）并不是一种全新的技术，而是建立在许多实际中已被证明是行之有效的技术和工具基础之上的技术。

从这种意义上说,CASE也可以被定义为“用自动化手段对结构化概念和设计方法重新进行组装”。

2.2case支持下的软件建模和文档编写工具

2.2.1processanalyst和dataarchitect

1.ProcessAnalyst

ProcessAnalyst模块的基本功能是通过建立过程分析模型，帮助系统分析人员收集数据，编写数据字典，并绘制数据流图。

其基本功能主要包括：

●对象建模技术（OMT）和数据流图（DFD）。

●建立层次化的处理模型。

●定制和打印模型文档。

●从（概念数据模型CDM）中引入数据项。

●应用对象链接与嵌入（OLE）技术链接和嵌入其他应用程序中的对象。

在结构化系统分析与设计中，可以采用多种方法建立过程分析模型，ProcessAnalyst

支持一下4种典型的模型方法：

●对象模型技术（ObjectModelingTechnique,OMT）功能模型。

●Yourdon/DeMarco方法。

●Gane&

Sarson方法。

●结构化系统分析与设计方法（Structuredsystemanalysisanddesignmethodology，SSADM）。

2.DataArchitect

DataArchitect具有如下功能：

用实体-关系图为信息系统建模。

在DataArchitect中，这种实体-关系图叫做概念数据模型，这是概念层次上的建模。

基于某一数据库管理系统生成相应的物理数据模型，这是物理层次上的建模。

定制物理数据模型以满足物理上和性能上的要求，这是对物理数据模型的维护。

为目标数据库管理系统生成一个数据库创建脚本。

如果目标数据库支持，生成参照完整性触发器。

定制并打印模型报告，生成概念数据模型和物理数据模型的设计文档。

从现在数据模型的对象定义扩展属性，利用扩展属性在4GL用户界面和物理数据模型之间传递信息，实现数据库设计与用户界面的接口。

3.报告生成器

2.2.2SoDA自动化文档设计和生成

1.SoDA的功能与特点

Rational公司提供的SoDA是一种强有力的软件文档自动生成器。

它使软件文档的生成实现了自动化,简化了软件开发中文档的生成过程,SoDA全面收集软件开发周期中各阶段信息并以之为基础制作文档。

极大提高了文档的可用性、易用性和连贯性,使文档更加有效。

SoDA可定制支持任何文档标准,从各种软件开发工具中截取数据,并可与各种支持编程语言的工具协同工作。

对SoDA的良好性能可概括如下:

●可自动从软件工程工具中获得信息。

●可使用