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