软件项目文档管理ch.ppt

《软件项目文档管理ch.ppt》由会员分享，可在线阅读，更多相关《软件项目文档管理ch.ppt（28页珍藏版）》请在三一办公上搜索。

1、第 10 章,IT软件项目文档管理（1次、2课时）,第10章 IT软件项目文档管理,10.1 软件项目文档管理概述 10.2 项目文档的质量 10.3 项目文档准备 10.4 主要项目文档 10.5 思考题,10.1 软件项目文档管理概述,10.1.1 项目文档管理的概念10.1.2 项目文档的分类10.1.3 过程文档10.1.4 产品文档,10.1.1 项目文档管理的概念,能作为开发组员之间交流沟通的媒介。能为软件项目的维护工程师提供有关信息系统的资料和知识库。能为项目管理者提供项目计划、预算、开发进度等各方面的信息。能作为最终用户或管理员的用户手册，使用户知道如何使用、维护及管理系统。,

2、概念属性：,10.1.2 项目文档的分类,过程文档，是指那些记录软件项目开发和维护过程的文档资料，项目的计划、进度、过程质量、组织及项目标准等都是过程文档。产品文档，是那些描述正在开发的产品的资料。这类文档又可以分为从软件工程师开发和维护系统的角度描述产品的系统文档，以及主要以客户为对象描述产品的用户文档。,文档可分为以下两大类，即过程文档和产品文档：,10.1.3 过程文档,软件项目计划、预测和进度安排文档：这些文档由项目经理负责产生，以便预测和控制软件的开发过程。相关报告：这些文档用来报告在软件开发过程中，资源是如何分配和利用的。标准报告：这些文档规定了软件过程应该如何实现，这些可以是国际

3、标准、国家标准、行业标准等。工作文档：这些文档是在项目开发中最主要的交流沟通工具，记录了软件项目开发中软件工程师的想法等。备忘录及电子信息：主要记录了每天项目经理和开发人员之间的详细交流信息。,过程文档可以分为如下几类：,10.1.4 产品文档,(1)系统功能描述(2)初级使用手册(3)系统参考手册(4)系统安装文档(5)系统管理员手册,产品文档可以分为用户文档和系统文档：,用户文档包括：,10.1.4 产品文档,10.1.4 产品文档,需求文档及相关的基本原理说明。系统体系结构文档。对系统的每一个程序，都有相应的程序体系结构文档。每个子系统的规范和设计说明书。程序代码列表。这些列表包括程序注

4、释、用来解释代码中复杂代码段和采用的编码方法等。描述每个程序怎样验证和验证信息与需求之间关系的验证文档。维护指导文档，主要描述系统已知的问题、软件支持、硬件支持等信息，以便维护时使用。,系统文档包括：,10.2 项目文档的质量,10.2.1 项目文档结构 10.2.2 文档标准10.2.3 文档书写风格,10.2.1 项目文档结构,主要信息：,10.2.2 文档标准,过程标准：这种标准定义了高质量文档应该遵守的过程。产品标准：这种标准操纵文档本身。交互标准：通过电子邮件和文档数据库交换文档变得越来越重要，交互标准使得所有的文档都存在可比性。,包括：,10.2.2 文档标准,10.2.3 文档书

5、写风格,运用主动的而不是被动的语气。运用正确的术语和语法结构。句子不宜过长，尽量用短句。段落简短。用词简洁，不要长篇累犊。简明定义用到的专业术语。应用标题和子标题。尽可能地逐条列举事实。不要单纯地参考数字、图、表来理解信息，应当有一定的说明和注释。,编写文档时，也应该注意以下问题：,10.3 项目文档准备,文档制作：文字处理器、文本格式器、表格和公式编辑器、绘图工具包等。文档修改：拼写检查器和风格检查器。文档产品发布：桌面发布包、技术工作包等。,文档的准备分3个阶段：,10.3 项目文档准备,文档管理系统：,10.4 主要项目文档,10.4.1 项目开发立项报告10.4.2 可行性研究报告10

6、.4.3 项目开发计划报告10.4.4 项目分析报告10.4.5 项目设计报告10.4.6 程序设计报告10.4.7 项目测试报告10.4.8 项目使用与维护手册10.4.9 项目评价报告10.4.10 项目开发总结报告,10.4.1 项目开发立项报告,(1)概述：概述现行系统的组织结构、功能、业务流程以及存在的主要问题。(2)新系统的目标：开发新系统的意义和新系统实现后的功能、技术指标、安全和保密性、新系统运行环境等。(3)经费预测和经费来源。(4)项目进度和完成期限。(5)验收标准和方法。(6)移交的文档资料。(7)开始可行性研究的组织队伍、机构与预算。(8)其他需要说明的有关问题。,包括

7、以下内容:,10.4.2 可行性研究报告,(1)系统概述。(2)新系统的目标、要求和约束。(3)可行性研究的基本准则。(4)现行系统描述及现行系统存在的主要问题。(5)新系统对现行系统的影响。(6)投资与效益分析。(7)其他可选方案及国内外同类方案的比较。(8)有关建议。,包括以下内容:,10.4.3 项目开发计划报告,(1)概述：主要包括系统开发的主要目标、基本方针、参加人员、工作阶段和内容等。(2)开发计划：系统开发各个工作阶段或者子项目的划分、任务、分工、负责人、计划时间(开始及结束时间)、人力资源需求、资金及设备消耗、实际执行情况等。可以用工作进度表、甘特图、网络图及关键路径法等工具辅

8、助管理。(3)验收标准：每项工作完成后验收的标准，包括时间、资金、质量等。(4)协调方法：项目开发中各个单位、阶段之间的衔接、协调方法、负责人、权限等。,包括以下内容:,10.4.4 项目分析报告,(1)概述。(2)系统需求。(3)新系统的目标与新鲜系统的功能。(4)新系统的逻辑模型。(5)新系统的运行环境。(6)新系统的验收标准与培训计划。,包括以下内容:,10.4.5 项目设计报告,(1)系统概述。(2)系统总体结构。(3)计算机系统配置方案。(4)代码设计。(5)文件/数据库设计。(6)输入输出设计。(7)计算机处理过程设计。(8)接口及通信环境设计。(9)安全保密设计。(10)数据准备

9、。(11)系统测试计划。(12)培训计划。,包括以下内容:,10.4.6 程序设计报告,(1)概述。(2)程序结构图。(3)程序控制图。(4)算法。(5)程序流程图。(6)源程序。(7)程序注释及说明。,包括以下内容:,10.4.7 项目测试报告,(1)概述：说明项目测试的目的。(2)测试环境：有关软、硬件、通信、数据库、人员等情况。(3)测试内容：系统、子系统、模块的名称、性能技术指标等。(4)测试方案：测试的方法、测试数据、测试步骤、测试中故障的解决方案等。(5)测试结果：测试的实际情况。(6)结论：项目功能评价、性能技术指标评价、结论。,包括以下内容:,10.4.8 项目使用与维护手册,

10、(1)概述：主要包括系统功能、系统运行环境(软硬件环境)、系统安装等内容。(2)使用说明：系统操作使用说明较为详细地说明了操作的目的、过程、方式、输入输出的数据等。最好将系统操作的界面图放入说明书中，便于使用者学习与操作。(3)问题解释：解释了系统使用中可能出现的问题及解决办法，如非常规操作命令、系统恢复过程及意外情况、与开发单位的联系方式等。,包括以下内容:,10.4.9 项目评价报告,(1)概述。(2)系统构成。(3)系统达到设计目标的情况。(4)系统的可靠性、安全性、保密性、可维护性等状况。(5)系统的经济效益与社会效益的评价。(6)总结性评价。,包括以下内容:,10.4.10 项目开发总结报告,(1)概述：包括项目的提供者、开发者、用户；项目开发的主要依据；项目开发的目的；项目开发的可行性分析等。(2)项目的完成情况：包括项目构成与主要功能；项目性能与技术指标；计划与实际进度对比；费用预算与实际费用的对比等。(3)项目评价：项目的主要特点；采用的技术方法与评价；项目工作效率与质量；存在的问题与原因；用户的评价与反馈意见。(4)经验与教训：项目开发过程中的经验与教训；对今后工作的建议；写出对外发表的论文。,包括以下内容:,10.5 思 考 题,参见教材170页,