it软件项目文档管理

第10章IT软件项目文档管理N101软件项目文档管理概述N102项目文档的质量N103项目文档准备N104主要项目文档2016/4/13上海海事大学计算机系1101软件项目文档管理概述N1011项目文档管理的概念N1012项目文档的分类N1013过程文档N1014产品文档2016/4/13上海海事大学计算机系21011项目文档管理的概念N1文档的地位N是IT软件项目开发中的重要组成部分N对于项目开发的成功和项目的正常维护起着重要的保证和支持作用N2项目文档的特点N任何项目都有数量众多的文档N一般文档数量的多少、规模的大小、结构的复杂程度与所开发软件的大小和复杂程度成正比N开发成本一大部分发生在文档的编制和准备过程中2016/4/13上海海事大学计算机系3N3文档的作用N能作为开发组员之间交流沟通的媒介。N能为软件项目的维护工程师提供有关信息系统的资料和知识库。N能为项目管理者提供项目计划、预算、开发进度等各方面的信息。N能作为最终用户或管理员的用户手册，使用户知道如何使用、维护及管理系统。2016/4/13上海海事大学计算机系41012项目文档的分类N1分类N文档可分为以下两大类，即过程文档和产品文档N过程文档是指那些记录软件项目开发和维护过程的文档资料，项目的计划、进度、过程质量、组织及项目标准等都是过程文档。N产品文档是那些描述正在开发的产品的资料。这类文档又可以分为从软件工程师开发和维护系统的角度描述产品的系统文档，以及主要以客户为对象描述产品的用户文档。2016/4/13上海海事大学计算机系5N2编写过程文档目的N在于所开发的产品能被很好地管理N产品文档一般在系统运行后才开始使用，同时它也对管理系统开发工作必不可少N不同时期编写的文档代表在软件开发过程中的一个重要阶段里程碑。2016/4/13上海海事大学计算机系61013过程文档（1）N1分类N软件项目计划、预测和进度安排文档这些文档由项目经理负责产生，以便预测和控制软件的开发过程。N相关报告这些文档用来报告在软件开发过程中，资源是如何分配和利用的。N标准报告这些文档规定了软件过程应该如何实现，这些可以是国际标准、国家标准、行业标准等。N工作文档这些文档是在项目开发中最主要的交流沟通工具，记录了软件项目开发中软件工程师的想法等。N备忘录及电子信息主要记录了每天项目经理和开发人员之间的详细交流信息。2016/4/13上海海事大学计算机系7N2过程文档特点N大部分文档都是已经过时了的。过程文档主要是软件项目开发过程中的各种事件和信息的记录。N计划可以是由周计划、日计划或月计划组成，进度一般以周为单位进行报告，记录软件工程师的想法和目的备忘录将不断被改变。N大多数信息在过时后将没有多少使用价值，一般也就没有再保存的必要，但也有例外，如测试计划等在软件开发过程中具有保存的价值，它是系统变更的基础；设计报告也具有保存的价值，它为维护系统提供依据等。2016/4/13上海海事大学计算机系81014产品文档（1）N1特点N产品文档主要描述已交付的软件产品情况N与过程文档不同，产品文档有很长的生命周期N必须随着产品一步步发展N2分类N产品文档可以分为用户文档和系统文档N用户文档以文档资料形式告诉用户如何利用该系统N系统文档主要为维护工程师服务2016/4/13上海海事大学计算机系9N3注意N在软件项目中，软件的用户并不完全相同，不同用户面向的文档也不一样，必须产生不同的文档来适应不同的任务和水平的用户N在编辑文档时，必须将最终用户和系统管理员区分开N最终用户主要是使用软件来完成一定的任务。他们只关心如何利用软件来帮助他们完成工作，不关心计算机和软件管理上其他细节N系统管理员负责管理最终用户使用的软件N2016/4/13上海海事大学计算机系101014产品文档（2）2016/4/13上海海事大学计算机系11系统管理员向导系统评估员功能性描述描述提供的服务系统管理员安装描述怎样安装系统新用户初级使用手册如何开始使用系统老用户参考手册所有系统功能的详细描述系统管理员如何操作和维护系统图101需要随软件系统发布而产生的部分用户文档1014产品文档（3）N4用户文档N系统功能描述简要描述系统的需求和提供的服务。该文档为系统提供一个总体的概念描述。用户通过阅读该文档，可以确定是不是他们所需要的系统。N初级使用手册为系统提供一个非正式的介绍，描述一些“常规”的使用操作。N系统参考手册描述系统的功能设施及其用途，能为错误信息提供一个完整的列表，并且描述怎样从发现的错误中恢复。系统参考手册应该是完整的和正式的。2016/4/13上海海事大学计算机系12N系统安装文档一般面向系统管理员，为系统管理员提供在特定环境下如何安装系统的详细说明。N系统管理员手册主要提供当系统与其他系统交互时所产生的信息，及如何对这些信息进行反应的说明。2016/4/13上海海事大学计算机系131014产品文档（4）N5系统文档N系统文档包括所有描述系统是如何从需求报告到最终变成可接受的系统过程中，与分析、设计、实施等方面有关的技术文档。N主要包括N需求文档及相关的基本原理说明。N系统体系结构文档。N对系统的每一个程序，都有相应的程序体系结构文档。N每个子系统的规范和设计说明书。2016/4/13上海海事大学计算机系14N程序代码列表。这些列表包括程序注释、用来解释代码中复杂代码段和采用的编码方法等。N描述每个程序怎样验证和验证信息与需求之间关系的验证文档。N维护指导文档，主要描述系统已知的问题、软件支持、硬件支持等信息，以便维护时使用。2016/4/13上海海事大学计算机系15N6文档编制的注意事项N系统维护的要求文档与文档之间的关系与依赖都应该记录在配置管理数据库中N修改代码引起的文档变化，应该采用记录文档关系的软件工具来支持文档维护，当一个文档变化引起其他文件变化是，提醒工程师2016/4/13上海海事大学计算机系16102项目文档的质量N1021项目文档结构N1022文档标准N1023文档书写风格2016/4/13上海海事大学计算机系17N1概述N文档质量与程序质量一样重要N没有说明如何使用系统和理解系统的文档，系统实用性会大打折扣N高质量文档产生既不容易也不便宜，与编制高质量的程序一样困难2016/4/13上海海事大学计算机系181021项目文档结构（1）N1文档结构的基本原则N文档的内容决定了文档的结构，文档结构随项目不同而不同，但一般都要符合以下的基本原则N所有文档（不论大小、长短）都应该有封面，用来标识该项目文档的作者、制作时间、文档类型、配置管理、质量确保信息和文档的秘级等，还包括文档的摘要、关键字及版权信息。如图102。N文档应分章节描述。N如果文档包括许多细节性参考信息，应该有附录。N文档应该有难点注释和详细说明。N文档的结构通常应当是严整的，并且有一定的标准。2016/4/13上海海事大学计算机系192016/4/13上海海事大学计算机系201021项目文档结构（2）文档封面的主要信息标题项目文档ID文档类型版本日期作者是否被检查是/否是否被同意N/A提交给CMCM_ID发布密级关键词图102项目文档封面的主要信息1022文档标准（1）N1重要性N文档标准是保证文档质量的基础，根据一定的标准编写文档可以有一致的外观、结构和质量等。N2类型N过程标准这种标准定义了高质量文档应该遵守的过程N产品标准这种标准操纵文档本身N交互标准通过电子邮件和文档数据库交换文档变得越来越重要，交互标准使得所有的文档都存在可比性。交互标准的使用允许文档通过电子化的方式传递，能够相互理解和规范，并且在最初的格式上进行再创作2016/4/13上海海事大学计算机系21N过程标准N定义了书写文档的方法，规定了书写文档时采用的软件工具，同时也定义了高质量文档的质量确保程序N过程标准必须灵活N文档编制过程是一个不断重复的过程，这个过程应该直到一个可接受的质量是才停止N可接受的质量水平依赖于文档的种类和它潜在的用户水平2016/4/13上海海事大学计算机系222016/4/13上海海事大学计算机系231022文档标准（2）文档编制过程图103文档编制过程阶段2修改阶段1编制编写最初文档评审文档整理评审意见修改文档校对文字最终文档确认最终文档设计文档复审文档打印文档打印备份文档阶段3发布N产品标准N适用于在软件开发过程中所产生的文档。N文档应该有一个统一的外观，同一类文档应该有统一的结构N应该基于更一般的行业标准2016/4/13上海海事大学计算机系241022文档标准（3）N文档编制中涉及到的一些产品标准有N文档识别标准项目都要产生许多文档，每一个文档都要求有一个独特的识别标准。对于正式的文档，它的识别标准可以是由配置管理人员专门定义的；对于非正式的文档，其识别标准可以由项目经理来定义。N文档结构标准在软件项目中每一种类型的文档都有一种合适的结构，结构标准就用来定义这种结构，可以采用传统的页码、页眉、页脚和章节等。N文档解释标准文档解释标准定义了文档的总体“建筑风格”，包括文档中字体的大小、颜色及风格的定义等。N文档更新标准系统的变更应在文档中反映，因此应该采用一种连续的方法来表示系统变更，即在文档中确定更新的标准。2016/4/13上海海事大学计算机系25N文档标准要适用于所有项目文档及用户文档的最初版本。2016/4/13上海海事大学计算机系261023文档书写风格N文档的质量依赖于编写者的文字组织能力，好的文档需要好的文笔N编写文档时要注意以下问题N运用主动的而不是被动的语气。N运用正确的术语和语法结构。N句子不宜过长，尽量用短句。N段落简短。N用词简洁，不要长篇累犊，质量比数量更重要。N简明定义用到的专业术语。2016/4/13上海海事大学计算机系271023文档书写风格N应用标题和子标题。N尽可能地逐条列举事实。N不要单纯地参考数字、图、表来理解信息，应当有一定的说明和注释。N文档要像程序一样采用相同的方法进行检测，在后期主要侧重在错误的发现而不是错误的修改机制上2016/4/13上海海事大学计算机系28103项目文档准备（1）N1阶段N文档制作文字处理器、文本格式器、表格和公式编辑器、绘图工具包等。N文档修改拼写检查器和风格检查器。N文档产品发布桌面发布包、技术工作包等。N最常用的文档工具是系统编辑器，它支持文档的产生和修改过程。2016/4/13上海海事大学计算机系29103项目文档准备（2）N文档管理系统2016/4/13上海海事大学计算机系30文档索引文档管理系统配置管理系统文档参考用户请求图104文档管理文档数据库文档管理系统可以维护关联文档的索引，并且从文档的文本中产生索引。可以采用标准数据库、配置管理工具和系统文件来建造。它是一个松散集成的系统，并且在部分系统里要求一定的原则。104主要项目文档N1041项目开发立项报告N1042可行性研究报告N1043项目开发计划报告N1044项目分析报告N1045项目设计报告N1046程序设计报告N1047项目测试报告N1048项目使用与维护手册N1049项目评价报告N10410项目开发总结报告2016/4/13上海海事大学计算机系312016/4/13上海海事大学计算机系321041项目开发立项报告N1概述概述现行系统的组织结构、功能、业务流程以及存在的主要问题。N2新系统的目标开发新系统的意义和新系统实现后的功能、技术指标、安全和保密性、新系统运行环境等。N3经费预测和经费来源。N4项目进度和完成期限。N5验收标准和方法。N6移交的文档资料。N7开始可行性研究的组织队伍、机构与预算。N8其他需要说明的有关问题。项目开发立项报告是在项目正式开发前，由开发单位提出或委托开发单位提出要开发的新系统的目标、功能、费用、时间、对组织机构的影响等内容的申请项目立项文档。项目开发立项报告主要包括以下内容2016/4/13上海海事大学计算机系331042可行性研究报告可行性研究报告主要包括以下内容N1系统概述。N2新系统的目标、要求和约束。N3可行性研究的基本准则。N4现行系统描述及现行系统存在的主要问题。N5新系统对现行系统的影响。N6投资与效益分析。N7其他可选方案及国内外同类方案的比较。N8有关建议。可行性研究阶段的文档是可行性研究报告。可行性研究报告是根据对现行系统的调查、分析和研究，提出若干个系统的开发方案及其评价，供领导进行决策。2016/4/13上海海事大学计算机系341043项目开发计划报告N1概述主要包括系统开发的主要目标、基本方针、参加人员、工作阶段和内容等。N2开发计划系统开发各个工作阶段或者子项目的划分、任务、分工、负责人、计划时间开始及结束时间、人力资源需求、资金及设备消耗、实际执行情况等。可以用工作进度表、甘特图、网络图及关键路径法等工具辅助管理。N3验收标准每项工作完成后验收的标准，包括时间、资金、质量等。N4协调方法项目开发中各个单位、阶段之间的衔接、协调方法、负责人、权限等。项目开发计划报告主要包括以下内容2016/4/13上海海事大学计算机系351044项目分析报告N1概述N2系统需求N3新系统的目标与新系统的功能N4新系统的逻辑模型N5新系统的运行环境N6新系统的验收标准与培训计划项目分析报告主要包括以下内容2016/4/13上海海事大学计算机系361045项目设计报告N1系统概述N2系统总体结构N3计算机系统配置方案N4代码设计N5文件/数据库设计N6输入输出设计N7计算机处理过程设计N8接口及通信环境设计N9安全保密设计N10数据准备N11系统测试计划N12培训计划包括以下内容2016/4/13上海海事大学计算机系371046程序设计报告N1概述N2程序结构图N3程序控制图N4算法N5程序流程图N6源程序N7程序注释及说明包括以下内容2016/4/13上海海事大学计算机系381047项目测试报告N1概述说明项目测试的目的。N2测试环境有关软、硬件、通信、数据库、人员等情况。N3测试内容系统、子系统、模块的名称、性能技术指标等。N4测试方案测试的方法、测试数据、测试步骤、测试中故障的解决方案等。N5测试结果测试的实际情况。N6结论项目功能评价、性能技术指标评价、结论。包括以下内容2016/4/13上海海事大学计算机系391048项目使用与维护手册N1概述主要包括系统功能、系统运行环境软硬件环境、系统安装等内容。N2使用说明系统操作使用说明较为详细地说明了操作的目的、过程、方式、输入输出的数据等。最好将系统操作的界面图放入说明书中，便于使用者学习与操作。N3问题解释解释了系统使用中可能出现的问题及解决办法，如非常规操作命令、系统恢复过程及意外情况、与开发单位的联系方式等。包括以下内容2016/4/13上海海事大学计