《第10章IT软件项目管理课件》由会员分享，可在线阅读，更多相关《第10章IT软件项目管理课件（32页珍藏版）》请在金锄头文库上搜索。
1、第第10章章 IT软件项目文档管理软件项目文档管理 n10.1 软件项目文档管理概述软件项目文档管理概述 n10.2 项目文档的质量项目文档的质量 n10.3 项目文档准备项目文档准备 n10.4 主要项目文档主要项目文档 9/4/20241辽辽宁宁工工程程技技术术大大学学 软软件件学学院院第10章 IT软件项目文档管理 10.1 软件项目文档管10.1 软件项目文档管理概述软件项目文档管理概述 n10.1.1 项目文档管理的概念项目文档管理的概念n10.1.2 项目文档的分类项目文档的分类n10.1.3 过程文档过程文档n10.1.4 产品文档产品文档 9/4/20242辽辽宁宁工工程程技技
2、术术大大学学 软软件件学学院院10.1 软件项目文档管理概述 10.1.1 项目文档管10.1.1 项目文档管理的概念项目文档管理的概念 n能作为开发组员之间交流沟通的媒介。能作为开发组员之间交流沟通的媒介。n能为软件项目的维护工程师提供有关信息系统的资料和能为软件项目的维护工程师提供有关信息系统的资料和知识库。知识库。n能为项目管理者提供项目计划、预算、开发进度等各方能为项目管理者提供项目计划、预算、开发进度等各方面的信息。面的信息。n能作为最终用户或管理员的用户手册，使用户知道如何能作为最终用户或管理员的用户手册，使用户知道如何使用、维护及管理系统。使用、维护及管理系统。与软件项目相关的项
3、目文档的概念属性有与软件项目相关的项目文档的概念属性有：n软件项目文档是软件项目文档是ITIT软件项目开发中的重要组成部分。文软件项目开发中的重要组成部分。文档对于项目开发的成功和项目的正常维护起着重要的保档对于项目开发的成功和项目的正常维护起着重要的保证和支持作用。证和支持作用。n一般：文档数量的多少、规模的大小、结构的复杂程度一般：文档数量的多少、规模的大小、结构的复杂程度与所开发软件的大小和复杂程度成正比。与所开发软件的大小和复杂程度成正比。9/4/20243辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.1 项目文档管理的概念 能作为开发组员之间交流沟10.1.2 项目文档
4、的分类项目文档的分类 n过过程程文文档档：是是指指那那些些记记录录软软件件项项目目开开发发和和维维护护过过程程的的文文档档资资料料，项项目目的的计计划划、进进度度、过过程程质质量量、组组织织及及项项目目标标准准等等都都是是过程文档。过程文档。n产品文档：产品文档：是那些描述正在开发的产品的资料。这类文档又是那些描述正在开发的产品的资料。这类文档又可以分为从软件工程师开发和维护系统的角度描述产品的系可以分为从软件工程师开发和维护系统的角度描述产品的系统文档，以及主要以客户为对象描述产品的用户文档。统文档，以及主要以客户为对象描述产品的用户文档。n编写过程文档的主要目的在于所开发的产品能被很好地管
5、理。编写过程文档的主要目的在于所开发的产品能被很好地管理。产品文档一般在系统运行后才开始使用，同时它也对管理系产品文档一般在系统运行后才开始使用，同时它也对管理系统开发工作必不可少。不同时期编写的文档代表在软件开发统开发工作必不可少。不同时期编写的文档代表在软件开发过程中的一个重要阶段里程碑。过程中的一个重要阶段里程碑。文档可分为以下两大类，即文档可分为以下两大类，即过程文档过程文档和和产品文档产品文档 ：9/4/20244辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.2 项目文档的分类 过程文档：是指那些记录软件项10.1.3 过程文档（过程文档（1 1） n软件件项目目计划划
6、、预测和和进度度安安排排文文档档：这些些文文档档由由项目目经理理负责产生，以便生，以便预测和控制和控制软件的开件的开发过程。程。n相相关关报告告：这些些文文档档用用来来报告告在在软件件开开发过程程中中，资源源是是如何分配和利用的。如何分配和利用的。n标准准报告告：这些些文文档档规定定了了软件件过程程应该如如何何实现，这些些可以是国可以是国际标准、国家准、国家标准、行准、行业标准等。准等。n工工作作文文档档：这些些文文档档是是在在项目目开开发中中最最主主要要的的交交流流沟沟通通工工具，具，记录了了软件件项目开目开发中中软件工程件工程师的想法等。的想法等。n备忘忘录及及电子子信信息息：主主要要记录
7、了了每每天天项目目经理理和和开开发人人员之之间的的详细交流信息。交流信息。过程文档可以分为如下几类：过程文档可以分为如下几类： 9/4/20245辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.3 过程文档（1） 软件项目计划、预测和进度安排10.1.3 过程文档（过程文档（2 2） n过程程文文档档的的最最大大特特点点是是：大大部部分分文文档档都都是是已已经过时了了的的。过程程文文档档主主要要是是软件件项目目开开发过程程中中的的各各种种事事件件和和信信息息的的记录。n在在过程程文文档档中中，计划划可可以以是是由由周周计划划、日日计划划或或月月计划划组成成，进度度一一般般以以周周为
8、单位位进行行报告告，记录软件件工工程程师的的想想法和目的法和目的备忘忘录将不断被改将不断被改变。n大大多多数数信信息息在在过时后后将将没没有有多多少少使使用用价价值，一一般般也也就就没没有有再再保保存存的的必必要要，但但也也有有例例外外，如如测试计划划等等在在软件件开开发过程程中中具具有有保保存存的的价价值，它它是是系系统变更更的的基基础；设计报告告也也具有保存的价具有保存的价值，它，它为维护系系统提供依据等。提供依据等。9/4/20246辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.3 过程文档（2） 过程文档的最大特点是：大部分10.1.4 产品文档（产品文档（1 1）n产品
9、文档主要描述已交付的软件产品情况，与大多数过程产品文档主要描述已交付的软件产品情况，与大多数过程文档不同，产品文档有很长的生命周期，它必须随着产品文档不同，产品文档有很长的生命周期，它必须随着产品一步步发展。一步步发展。n产品文档可以分为产品文档可以分为用户文档用户文档和和系统文档系统文档n用户文档以文档资料形式告诉用户如何利用该系统；用户文档以文档资料形式告诉用户如何利用该系统；n系统文档主要为维护工程师服务。系统文档主要为维护工程师服务。n在软件项目中，软件的用户并不完全相同，不同用户面向在软件项目中，软件的用户并不完全相同，不同用户面向的文档也不一样，因此，在编辑文档时，必须将最终用户的
10、文档也不一样，因此，在编辑文档时，必须将最终用户和系统管理员区分开。和系统管理员区分开。n最终用户主要是使用软件来完成一定的任务。他们只关心最终用户主要是使用软件来完成一定的任务。他们只关心如何利用软件来帮助他们完成工作，不关心计算机和软件如何利用软件来帮助他们完成工作，不关心计算机和软件管理上其他细节。管理上其他细节。n系统管理员负责管理最终用户使用的软件。系统管理员负责管理最终用户使用的软件。9/4/20247辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.4 产品文档（1）产品文档主要描述已交付的软件产10.1.4 产品文档（产品文档（2 2） 系统管理员向导系统管理员向导系
11、统评估员系统评估员功能性描述功能性描述描述提供描述提供的服务的服务系统管理员系统管理员安装描述安装描述怎样安怎样安装系统装系统新用户新用户初级使用手册初级使用手册如何开始如何开始使用系统使用系统老用户老用户参考手册参考手册所有系统功能所有系统功能的详细描述的详细描述系统管理员系统管理员如何操作和如何操作和维护系统维护系统图图10.1 10.1 需要随软件系统发布而产生的部分用户文档需要随软件系统发布而产生的部分用户文档9/4/20248辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.4 产品文档（2） 系统管理员向导系统评估员功能10.1.4 产品文档（产品文档（3 3）用户文档用
12、户文档 n系系统统功功能能描描述述：简简要要描描述述系系统统的的需需求求和和提提供供的的服服务务。该该文文档档为为系系统统提提供供一一个个总总体体的的概概念念描描述述。用用户户通通过过阅阅读读该该文文档档，可以确定是不是他们所需要的系统。可以确定是不是他们所需要的系统。n初初级级使使用用手手册册：为为系系统统提提供供一一个个非非正正式式的的介介绍绍，描描述述一一些些“常规常规”的使用操作。的使用操作。n系系统统参参考考手手册册：描描述述系系统统的的功功能能设设施施及及其其用用途途，能能为为错错误误信信息息提提供供一一个个完完整整的的列列表表，并并且且描描述述怎怎样样从从发发现现的的错错误误中中
13、恢复。系统参考手册应该是完整的和正式的。恢复。系统参考手册应该是完整的和正式的。n系系统统安安装装文文档档：一一般般面面向向系系统统管管理理员员，为为系系统统管管理理员员提提供供在特定环境下如何安装系统的详细说明。在特定环境下如何安装系统的详细说明。n系系统统管管理理员员手手册册：主主要要提提供供当当系系统统与与其其他他系系统统交交互互时时所所产产生的信息，及如何对这些信息进行反应的说明。生的信息，及如何对这些信息进行反应的说明。9/4/20249辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.4 产品文档（3）用户文档 系统功能描述：简10.1.4 产品文档（产品文档（4 4）系
14、统系统文档文档 n系系统文文档档包包括括所所有有描描述述系系统是是如如何何从从需需求求报告告到到最最终变成成可可接接受受的的系系统过程程中中，与与分分析析、设计、实施施等等方方面面有有关关的的技技术文档。文档。n系系统文档主要包括文档主要包括：n需求文档及相关的基本原理需求文档及相关的基本原理说明。明。n系系统体系体系结构文档。构文档。n对系系统的每一个程序，都有相的每一个程序，都有相应的程序体系的程序体系结构文档。构文档。n每个子系每个子系统的的规范和范和设计说明明书。n程程序序代代码列列表表。这些些列列表表包包括括程程序序注注释、用用来来解解释代代码中中复复杂代代码段和采用的段和采用的编码
15、方法等。方法等。n描描述述每每个个程程序序怎怎样验证和和验证信信息息与与需需求求之之间关关系系的的验证文档。文档。n维护指指导文文档档，主主要要描描述述系系统已已知知的的问题、软件件支支持持、硬硬件支持等信息，以便件支持等信息，以便维护时使用。使用。9/4/202410辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.1.4 产品文档（4）系统文档 系统文档包括所有10.2 项目文档的质量项目文档的质量 n10.2.1 项目文档结构项目文档结构 n10.2.2 文档标准文档标准n10.2.3 文档书写风格文档书写风格 9/4/202411辽辽宁宁工工程程技技术术大大学学 软软件件学学院院
16、10.2 项目文档的质量 10.2.1 项目文档结构 910.2.1 项目文档结构（项目文档结构（1）n文档的内容决定了文档的结构，文档结构随项目不同而不同，文档的内容决定了文档的结构，文档结构随项目不同而不同，但一般都要符合以下的但一般都要符合以下的基本原则基本原则：n所有文档（不论大小、长短）都应该有封面，用来标识该项所有文档（不论大小、长短）都应该有封面，用来标识该项目文档的作者、制作时间、文档类型、配置管理、质量确保目文档的作者、制作时间、文档类型、配置管理、质量确保信息和文档的秘级等，还包括文档的摘要、关键字及版权信信息和文档的秘级等，还包括文档的摘要、关键字及版权信息。息。如图如图
17、10.2。n文档应分章节描述。文档应分章节描述。n如果文档包括许多细节性参考信息，应该有附录。如果文档包括许多细节性参考信息，应该有附录。n文档应该有难点注释和详细说明。文档应该有难点注释和详细说明。n文档的结构通常应当是严整的，并且有一定的标准。文档的结构通常应当是严整的，并且有一定的标准。9/4/202412辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.2.1 项目文档结构（1）文档的内容决定了文档的结构10.2.1 项目文档结构（项目文档结构（2） 文档封面的主要信息文档封面的主要信息：标题：标题：项目：项目：文档文档ID：文档类型：文档类型：版本：版本： 日期：日期：作者：作
18、者：是否被检查：是否被检查： 是是/否否 是否被同意：是否被同意：N/A提交给提交给CM： CM _ID：发布：发布：密级：密级：关键词：关键词：图图10.2 10.2 项目文档封面的主要信息项目文档封面的主要信息9/4/202413辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.2.1 项目文档结构（2） 文档封面的主要信息：标题10.2.2 文档标准（文档标准（1 1） n过程程标准准：这种种标准准定定义了了高高质量量文文档档应该遵遵守守的的过程程，定定义了了书写文档的方法。写文档的方法。n产品品标准准：这种种标准准操操纵文文档档本本身身。适适用用于于在在软件件开开发过程中所有程中
19、所有产生的文档。生的文档。n交交互互标准准：通通过电子子邮件件和和文文档档数数据据库交交换文文档档变得得越越来来越越重重要要，交交互互标准准使使得得所所有有的的文文档档都都存存在在可可比比性性。交交互互标准准的的使使用用允允许文文档档通通过电子子化化的的方方式式进行行传递，能能够相相互互理解和理解和规范，并且在最初的格式上范，并且在最初的格式上进行再行再创造。造。包括：包括：文档标准是保证文档质量的基础，根据一定的标准编写文文档标准是保证文档质量的基础，根据一定的标准编写文档，可以有一致的外观、结构和质量等。档，可以有一致的外观、结构和质量等。9/4/202414辽辽宁宁工工程程技技术术大大学
20、学 软软件件学学院院10.2.2 文档标准（1） 过程标准：这种标准定义了高质10.2.2 文档标准（文档标准（2 2）文档编制过程文档编制过程 图图10.3 10.3 文档编制过程文档编制过程阶段阶段2：修改：修改阶段阶段1：编制：编制编写最初文档编写最初文档评审文档评审文档整理评审意见整理评审意见修改文档修改文档校对文字校对文字最终文档最终文档确认最终文档确认最终文档设计文档设计文档复审文档复审文档打印文档打印文档打印备份文档打印备份文档阶段阶段3：发布：发布9/4/202415辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.2.2 文档标准（2）文档编制过程 图10.3 10.2
21、.2 文档标准（文档标准（3 3）n文档编制中涉及到的一些产品标准有：文档编制中涉及到的一些产品标准有：n文档识别标准文档识别标准：项目都要产生许多文档，每一个文档都要求有：项目都要产生许多文档，每一个文档都要求有一个独特的识别标准。对于正式的文档，它的识别标准可以是一个独特的识别标准。对于正式的文档，它的识别标准可以是由配置管理人员专门定义的；对于非正式的文档，其识别标准由配置管理人员专门定义的；对于非正式的文档，其识别标准可以由项目经理来定义。可以由项目经理来定义。n文档结构标准文档结构标准：在软件项目中每一种类型的文档都有一种合适：在软件项目中每一种类型的文档都有一种合适的结构，结构标准
22、就用来定义这种结构，可以采用传统的页码、的结构，结构标准就用来定义这种结构，可以采用传统的页码、页眉、页脚和章节等。页眉、页脚和章节等。n文档解释标准文档解释标准：文档解释标准定义了文档的总体：文档解释标准定义了文档的总体“建筑风格建筑风格”，包括文档中字体的大小、颜色及风格的定义等。，包括文档中字体的大小、颜色及风格的定义等。n文档更新标准文档更新标准：系统的变更应在文档中反映，因此应该采用一：系统的变更应在文档中反映，因此应该采用一种连续的方法来表示系统变更，即在文档中确定更新的标准。种连续的方法来表示系统变更，即在文档中确定更新的标准。n文档标准要适用于所有项目文档及用户文档的最初版本。
23、文档标准要适用于所有项目文档及用户文档的最初版本。9/4/202416辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.2.2 文档标准（3）文档编制中涉及到的一些产品标准10.2.3 文档书写风格文档书写风格 n运用主动的而不是被动的语气。运用主动的而不是被动的语气。 n运用正确的术语和语法结构。运用正确的术语和语法结构。 n句子不宜过长，尽量用短句。句子不宜过长，尽量用短句。n段落简短。段落简短。 n用词简洁，不要长篇累犊，质量比数量更重要。用词简洁，不要长篇累犊，质量比数量更重要。 n简明定义用到的专业术语。简明定义用到的专业术语。 n应用标题和子标题。应用标题和子标题。 n尽可能
24、地逐条列举事实。尽可能地逐条列举事实。 n不不要要单单纯纯地地参参考考数数字字、图图、表表来来理理解解信信息息，应应当当有有一一定定的的说明和注释。说明和注释。编写文档时，也应该注意以下问题：编写文档时，也应该注意以下问题：9/4/202417辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.2.3 文档书写风格 运用主动的而不是被动的语气。 10.3 项目文档准备（项目文档准备（1 1） n文文档档制制作作：文文字字处理理器器、文文本本格格式式器器、表表格格和和公式公式编辑器、器、绘图工具包等。工具包等。n文档修改文档修改：拼写：拼写检查器和器和风格格检查器。器。n文档文档产品品发布布
25、：桌面：桌面发布包、技布包、技术工作包等。工作包等。 最最常常用用的的文文档档工工具具是是系系统编辑器器，它它支支持持文文档档的的产生和修改生和修改过程。程。文档的准备分文档的准备分3个阶段个阶段 ：9/4/202418辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.3 项目文档准备（1） 文档制作：文字处理器、文本格10.3 项目文档准备（项目文档准备（2 2） 文档管理系统文档管理系统 ：文档索引文档索引文档管理系统文档管理系统配置管理系统配置管理系统文档参考文档参考用户请求用户请求图图10.4 10.4 文档管理文档管理文档数据库文档数据库 文档管理系统可以维护关联文档的索引，并
26、且从文档的文本文档管理系统可以维护关联文档的索引，并且从文档的文本中产生索引。可以采用标准数据库、配置管理工具和系统文件中产生索引。可以采用标准数据库、配置管理工具和系统文件来建造。它是一个松散集成的系统，并且在部分系统里要求一来建造。它是一个松散集成的系统，并且在部分系统里要求一定的原则。定的原则。9/4/202419辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.3 项目文档准备（2） 文档管理系统 ：文档索引文档10.4 主要项目文档主要项目文档 n10.4.1 项目开发立项报告项目开发立项报告n10.4.2 可行性研究报告可行性研究报告n10.4.3 项目开发计划报告项目开发计
27、划报告n10.4.4 项目分析报告项目分析报告n10.4.5 项目设计报告项目设计报告n10.4.6 程序设计报告程序设计报告n10.4.7 项目测试报告项目测试报告n10.4.8 项目使用与维护手册项目使用与维护手册n10.4.9 项目评价报告项目评价报告n10.4.10 项目开发总结报告项目开发总结报告 9/4/202420辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4 主要项目文档 10.4.1 项目开发立项报告910.4.1 项目开发立项报告项目开发立项报告 n(1) 概概述述：概概述述现行行系系统的的组织结构构、功功能能、业务流流程程以以及存在的主要及存在的主要问题。n(
28、2) 新新系系统的的目目标：开开发新新系系统的的意意义和和新新系系统实现后后的的功能、技功能、技术指指标、安全和保密性、新系、安全和保密性、新系统运行运行环境等。境等。n(3) 经费预测和和经费来源。来源。n(4) 项目目进度和完成期限。度和完成期限。n(5) 验收收标准和方法。准和方法。n(6) 移交的文档移交的文档资料。料。n(7) 开始可行性研究的开始可行性研究的组织队伍、机构与伍、机构与预算。算。n(8) 其他需要其他需要说明的有关明的有关问题。项项目目开开发发立立项项报报告告是是在在项项目目正正式式开开发发前前，由由开开发发单单位位提提出出或或委委托托开开发发单单位位提提出出要要开开
29、发发的的新新系系统统的的目目标标、功功能能、费费用用、时时间间、对组织机构的影响等内容的申请项目立项文档。对组织机构的影响等内容的申请项目立项文档。项目开发立项报告主要包括以下内容项目开发立项报告主要包括以下内容 :9/4/202421辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.1 项目开发立项报告 (1) 概述：概述现行系统10.4.2 可行性研究报告可行性研究报告 可行性研究报告主要包括以下内容可行性研究报告主要包括以下内容 :n(1) 系系统概述。概述。n(2) 新系新系统的目的目标、要求和、要求和约束。束。n(3) 可行性研究的基本准可行性研究的基本准则。n(4) 现行
30、系行系统描述及描述及现行系行系统存在的主要存在的主要问题。n(5) 新系新系统对现行系行系统的影响。的影响。n(6) 投投资与效益分析。与效益分析。n(7) 其他可其他可选方案及国内外同方案及国内外同类方案的比方案的比较。n(8) 有关建有关建议。可可行行性性研研究究阶阶段段的的文文档档是是可可行行性性研研究究报报告告。可可行行性性研研究究报报告告是是根根据据对对现现行行系系统统的的调调查查、分分析析和和研研究究，提提出出若若干干个个系系统统的的开发方案及其评价，供领导进行决策。开发方案及其评价，供领导进行决策。9/4/202422辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.2
31、 可行性研究报告 可行性研究报告主要包括以下内10.4.3 项目开发计划报告项目开发计划报告 n(1)概概述述：主主要要包包括括系系统开开发的的主主要要目目标、基基本本方方针、参参加人加人员、工作、工作阶段和内容等。段和内容等。n(2)开开发计划划：系系统开开发各各个个工工作作阶段段或或者者子子项目目的的划划分分、任任务、分分工工、负责人人、计划划时间(开开始始及及结束束时间)、人人力力资源源需需求求、资金金及及设备消消耗耗、实际执行行情情况况等等。可可以以用用工工作作进度度表表、甘甘特特图、网网络图及及关关键路路径径法法等等工工具具辅助助管理。管理。n(3)验收收标准准：每每项工工作作完完成
32、成后后验收收的的标准准，包包括括时间、资金、金、质量等。量等。n(4)协调方方法法：项目目开开发中中各各个个单位位、阶段段之之间的的衔接接、协调方法、方法、负责人、人、权限等。限等。项目开发计划报告主要包括以下内容项目开发计划报告主要包括以下内容 :9/4/202423辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.3 项目开发计划报告 (1)概述：主要包括系统开10.4.4 项目分析报告项目分析报告 n(1) 概述概述n(2) 系系统需求需求n(3) 新系新系统的目的目标与新系与新系统的功能的功能n(4) 新系新系统的的逻辑模型模型n(5) 新系新系统的运行的运行环境境n(6)
33、新系新系统的的验收收标准与培准与培训计划划项目分析报告主要包括以下内容项目分析报告主要包括以下内容 :9/4/202424辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.4 项目分析报告 (1) 概述项目分析报告主要包10.4.5 项目设计报告项目设计报告 n(1) 系系统概述概述n(2) 系系统总体体结构构n(3) 计算机系算机系统配置方案配置方案n(4) 代代码设计n(5) 文件文件/数据数据库设计n(6) 输入入输出出设计n(7) 计算机算机处理理过程程设计n(8) 接口及通信接口及通信环境境设计n(9) 安全保密安全保密设计n(10)数据准数据准备n(11)系系统测试计划划
34、n(12)培培训计划划包括以下内容包括以下内容 :9/4/202425辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.5 项目设计报告 (1) 系统概述包括以下内容10.4.6 程序设计报告程序设计报告 n(1) 概述概述n(2) 程序程序结构构图n(3) 程序控制程序控制图n(4) 算法算法n(5) 程序流程程序流程图n(6) 源程序源程序n(7) 程序注程序注释及及说明明包括以下内容包括以下内容 :9/4/202426辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.6 程序设计报告 (1) 概述包括以下内容 :910.4.7 项目测试报告项目测试报告 n(1) 概述
35、：概述：说明明项目目测试的目的。的目的。n(2) 测试环境境：有有关关软、硬硬件件、通通信信、数数据据库、人人员等等情况。情况。n(3) 测试内内容容：系系统、子子系系统、模模块的的名名称称、性性能能技技术指指标等。等。n(4) 测试方方案案：测试的的方方法法、测试数数据据、测试步步骤、测试中故障的解决方案等。中故障的解决方案等。n(5) 测试结果：果：测试的的实际情况。情况。n(6) 结论：项目功能目功能评价、性能技价、性能技术指指标评价、价、结论。包括以下内容包括以下内容 :9/4/202427辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.7 项目测试报告 (1) 概述：说明
36、项目测试的目10.4.8 项目使用与维护手册项目使用与维护手册 n(1) 概概述述：主主要要包包括括系系统功功能能、系系统运运行行环境境(软硬硬件件环境境)、系系统安装等内容。安装等内容。n(2) 使使用用说明明：系系统操操作作使使用用说明明较为详细地地说明明了了操操作作的的目目的的、过程程、方方式式、输入入输出出的的数数据据等等。最最好好将将系系统操操作的界面作的界面图放入放入说明明书中，便于使用者学中，便于使用者学习与操作。与操作。n(3) 问题解解释：解解释了了系系统使使用用中中可可能能出出现的的问题及及解解决决办法法，如如非非常常规操操作作命命令令、系系统恢恢复复过程程及及意意外外情情
37、况况、与与开开发单位的位的联系方式等。系方式等。包括以下内容包括以下内容 :9/4/202428辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.8 项目使用与维护手册 (1) 概述：主要包括系10.4.9 项目评价报告项目评价报告 n项目目评价价报告告主主要要根根据据项目目可可行行性性分分析析报告告、项目目分分析析报告告、项目目设计报告告所所确确定定的的新新系系统的的目目标、功功能能、性性能能、计划划执行行情情况况、新新系系统实现后后的的经济效效益益和和社社会会效效益益等等方方面面进行行评价。价。项目评价报告主要包括以下内容项目评价报告主要包括以下内容 :n(1) 概述概述n(2)
38、 系系统构成构成n(3) 系系统达到达到设计目目标的情况的情况n(4) 系系统的可靠性、安全性、保密性、可的可靠性、安全性、保密性、可维护性等状况性等状况n(5) 系系统的的经济效益与社会效益的效益与社会效益的评价价n(6) 总结性性评价价9/4/202429辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.9 项目评价报告 项目评价报告主要根据项目可行性10.4.10 项目开发总结报告项目开发总结报告 n项目目开开发总结报告告中中在在项目目正正式式运运行行一一段段时间后后，开开发人人员所所做做的的工工作作总结，目目的的是是总结经验，找找出出不不足足，为今今后后的的开开发工作提供借工
39、作提供借鉴。项目发总结报告主要包括以下内容项目发总结报告主要包括以下内容 :n(1) 概概述述：包包括括项目目的的提提供供者者、开开发者者、用用户；项目目开开发的的主要依据；主要依据；项目开目开发的目的；的目的；项目开目开发的可行性分析等。的可行性分析等。n(2) 项目目的的完完成成情情况况：包包括括项目目构构成成与与主主要要功功能能；项目目性性能能与与技技术指指标；计划划与与实际进度度对比比；费用用预算算与与实际费用用的的对比等。比等。n(3) 项目目评价价：项目目的的主主要要特特点点；采采用用的的技技术方方法法与与评价价；项目目工工作作效效率率与与质量量；存存在在的的问题与与原原因因；用用
40、户的的评价价与与反反馈意意见。n(4) 经验与与教教训：项目目开开发过程程中中的的经验与与教教训；对今今后后工工作的建作的建议；写出；写出对外外发表的表的论文。文。9/4/202430辽辽宁宁工工程程技技术术大大学学 软软件件学学院院10.4.10 项目开发总结报告 项目开发总结报告中在项目本章小结主要项目文档主要项目文档项目开发立项报告项目开发立项报告可行性研究报告可行性研究报告项目开发计划报告项目开发计划报告项目分析报告项目分析报告项目设计报告项目设计报告程序设计报告程序设计报告项目测试报告项目测试报告项目使用与维护手册项目使用与维护手册项目评价报告项目评价报告项目开发总结报告项目开发总结
41、报告软件项目文档管理概述软件项目文档管理概述项目文档管理概念项目文档管理概念项目文档的分类项目文档的分类过程文档过程文档产品文档产品文档项目文档的质量项目文档的质量项目文档结构项目文档结构文档标准文档标准文档书写风格文档书写风格项目文档准备项目文档准备文档制作、文档修改文档制作、文档修改文档产品发布文档产品发布9/4/202431辽辽宁宁工工程程技技术术大大学学 软软件件学学院院本章小结主要项目文档软件项目文档管理概述9/24/20223作业：1 项目文档管理的概念，说明其重要性2 软件项目文档有哪几类？每类文档的特点与内容？3 如何评价文档的质量4说明软件文档的标准，包括那些类型。9/4/202432辽辽宁宁工工程程技技术术大大学学 软软件件学学院院作业：1 项目文档管理的概念，说明其重要性9/24/2022
