软件项目文档管理
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
定的说明和注释。
10.3 项目文档准备
文档的准备分3个阶段 ：
文档制作：文字处理器、文本格式器、表格 和公式编辑器、绘图工具包等。
文档修改：拼写检查器和风格检查器。 文档产品发布：桌面发布包、技术工作包等。
10.3 项目文档准备
文档管理系统 ：
用户请求 文档管理系统
文档参考
配置管理系统
(3) 项目评价：项目的主要特点；采用的技术方法与评价； 项目工作效率与质量；存在的问题与原因；用户的评价与 反馈意见。
(4) 经验与教训：项目开发过程中的经验与教训；对今后工 作的建议；写出对外发表的论文。
IT软件项目文档管理
第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.4.2 可行性研究报告
包括以下内容 :
(1) 系统概述。 (2) 新系统的目标、要求和约束。 (3) 可行性研究的基本准则。 (4) 现行系统描述及现行系统存在的主要问题。 (5) 新系统对现行系统的影响。 (6) 投资与效益分析。 (7) 其他可选方案及国内外同类方案的比较。 (8) 有关建议。
需求文档及相关的基本原理说明。 系统体系结构文档。 对系统的每一个程序，都有相应的程序体系结构文档。 每个子系统的规范和设计说明书。 程序代码列表。这些列表包括程序注释、用来解释代码中复杂
代码段和采用的编码方法等。 描述每个程序怎样验证和验证信息与需求之间关系的验证文档。 维护指导文档，主要描述系统已知的问题、软件支持、硬件支
10.4.5 项目设计报告
包括以下内容 :
(1) 系统概述。 (2) 系统总体结构。 (3) 计算机系统配置方案。 (4) 代码设计。 (5) 文件/数据库设计。 (6) 输入输出设计。 (7) 计算机处理过程设计。 (8) 接口及通信环境设计。 (9) 安全保密设计。 (10)数据准备。 (11)系统测试计划。 (12)培训计划。
(3) 问题解释：解释了系统使用中可能出现的问题及 解决办法，如非常规操作命令、系统恢复过程及意 外情况、与开发单位的联系方式等。
10.4.9 项目评价报告
包括以下内容 :
(1) 概述。 (2) 系统构成。 (3) 系统达到设计目标的情况。 (4) 系统的可靠性、安全性、保密性、可维护性
10.1.1 项目文档管理的概念
概念属性：
能作为开发组员之间交流沟通的媒介。 能为软件项目的维护工程师提供有关信息系统的资
料和知识库。 能为项目管理者提供项目计划、预算、开发进度等
各方面的信息。 能作为最终用户或管理员的用户手册，使用户知道
如何使用、维护及管理系统。
10.1.2 项目文档的分类
10.4.3 项目开发计划报告
包括以下内容 :
(1)概述：主要包括系统开发的主要目标、基本方针、参 加人员、工作阶段和内容等。
(2)开发计划：系统开发各个工作阶段或者子项目的划分、 任务、分工、负责人、计划时间(开始及结束时间)、人力 资源需求、资金及设备消耗、实际执行情况等。可以用 工作进度表、甘特图、网络图及关键路径法等工具辅助 管理。
10.1.4 产品文档
系统评估员 系统管理员
新用户
老用户
系统管理员
功能性描述 安装描述 初级使用手册 参考手册 系统管理员向导
描述提供 的服务
怎样安 装系统
如何开始 所有系统功能 如何操作和
使用系统 的详细描述
维护系统
图10.1 需要随软件系统发布而产生的部分用户文档
10.1.4 产品文档
系统文档包括：
障的解决方案等。 (5) 测试结果：测试的实际情况。 (6) 结论：项目功能评价、性能技术指标评价、结论。
10.4.8 项目使用与维护手册
包括以下内容 :
(1) 概述：主要包括系统功能、系统运行环境(软硬 件环境)、系统安装等内容。
(2) 使用说明：系统操作使用说明较为详细地说明了 操作的目的、过程、方式、输入输出的数据等。最 好将系统操作的界面图放入说明书中，便于使用者 学习与操作。
是否被同意：N/A CM _ID：
图10.2 项目文档封面的主要信息
10.2.2 文档标准
包括：
过程标准：这种标准定义了高质量文档应该 遵守的过程。
产品标准：这种标准操纵文档本身。 交互标准：通过电子邮件和文档数据库交换
文档变得越来越重要，交互标准使得所有的 文档都存在可比性。
10.2.2 文档标准
持等信息，以便维护时使用。
10.2 项目文档的质量
10.2.1 项目文档结构 10.2.2 文档标准 10.2.3 文档书写风格
ቤተ መጻሕፍቲ ባይዱ
10.2.1 项目文档结构
主要信息：
标题： 项目： 文档ID： 文档类型： 版本： 作者： 是否被检查： 是/否 提交给CM： 发布： 密级： 关键词：
日期：
工作文档：这些文档是在项目开发中最主要的交流沟通工具， 记录了软件项目开发中软件工程师的想法等。
备忘录及电子信息：主要记录了每天项目经理和开发人员之间 的详细交流信息。
10.1.4 产品文档
产品文档可以分为用户文档和系统文档：
用户文档包括：
(1) 系统功能描述 (2) 初级使用手册 (3) 系统参考手册 (4) 系统安装文档 (5) 系统管理员手册
(3)验收标准：每项工作完成后验收的标准，包括时间、 资金、质量等。
(4)协调方法：项目开发中各个单位、阶段之间的衔接、 协调方法、负责人、权限等。
10.4.4 项目分析报告
包括以下内容 :
(1) 概述。 (2) 系统需求。 (3) 新系统的目标与新鲜系统的功能。 (4) 新系统的逻辑模型。 (5) 新系统的运行环境。 (6) 新系统的验收标准与培训计划。
10.4.6 程序设计报告
包括以下内容 :
(1) 概述。 (2) 程序结构图。 (3) 程序控制图。 (4) 算法。 (5) 程序流程图。 (6) 源程序。 (7) 程序注释及说明。
10.4.7 项目测试报告
包括以下内容 :
(1) 概述：说明项目测试的目的。 (2) 测试环境：有关软、硬件、通信、数据库、人员等情况。 (3) 测试内容：系统、子系统、模块的名称、性能技术指标等。 (4) 测试方案：测试的方法、测试数据、测试步骤、测试中故
10.1.3 过程文档
过程文档可以分为如下几类：
软件项目计划、预测和进度安排文档：这些文档由项目经理负 责产生，以便预测和控制软件的开发过程。
相关报告：这些文档用来报告在软件开发过程中，资源是如何 分配和利用的。
标准报告：这些文档规定了软件过程应该如何实现，这些可以 是国际标准、国家标准、行业标准等。
编写最初文档
评审文档
整理评审意见
修改文档
阶段1：编制 校对文字
阶段2：修改
最终文档
确认最终文档
设计文档 阶段3：发布
复审文档
打印文档
图10.3 文档编制过程
打印备份文档
10.2.3 文档书写风格
编写文档时，也应该注意以下问题：
运用主动的而不是被动的语气。 运用正确的术语和语法结构。 句子不宜过长，尽量用短句。 段落简短。 用词简洁，不要长篇累犊。 简明定义用到的专业术语。 应用标题和子标题。 尽可能地逐条列举事实。 不要单纯地参考数字、图、表来理解信息，应当有一
10.4.1 项目开发立项报告
包括以下内容 :
(1) 概述：概述现行系统的组织结构、功能、业务流程以 及存在的主要问题。
(2) 新系统的目标：开发新系统的意义和新系统实现后的 功能、技术指标、安全和保密性、新系统运行环境等。
(3) 经费预测和经费来源。 (4) 项目进度和完成期限。 (5) 验收标准和方法。 (6) 移交的文档资料。 (7) 开始可行性研究的组织队伍、机构与预算。 (8) 其他需要说明的有关问题。
等状况。 (5) 系统的经济效益与社会效益的评价。 (6) 总结性评价。
10.4.10 项目开发总结报告
包括以下内容 :
(1) 概述：包括项目的提供者、开发者、用户；项目开发的 主要依据；项目开发的目的；项目开发的可行性分析等。
(2) 项目的完成情况：包括项目构成与主要功能；项目性能 与技术指标；计划与实际进度对比；费用预算与实际费用 的对比等。
文档索引
文档数据库 图10.4 文档管理
10.4 主要项目文档
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 项目开发总结报告
10.3 项目文档准备
文档的准备分3个阶段 ：
文档制作：文字处理器、文本格式器、表格 和公式编辑器、绘图工具包等。
文档修改：拼写检查器和风格检查器。 文档产品发布：桌面发布包、技术工作包等。
10.3 项目文档准备
文档管理系统 ：
用户请求 文档管理系统
文档参考
配置管理系统
(3) 项目评价：项目的主要特点；采用的技术方法与评价； 项目工作效率与质量；存在的问题与原因；用户的评价与 反馈意见。
(4) 经验与教训：项目开发过程中的经验与教训；对今后工 作的建议；写出对外发表的论文。
IT软件项目文档管理
第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.4.2 可行性研究报告
包括以下内容 :
(1) 系统概述。 (2) 新系统的目标、要求和约束。 (3) 可行性研究的基本准则。 (4) 现行系统描述及现行系统存在的主要问题。 (5) 新系统对现行系统的影响。 (6) 投资与效益分析。 (7) 其他可选方案及国内外同类方案的比较。 (8) 有关建议。
需求文档及相关的基本原理说明。 系统体系结构文档。 对系统的每一个程序，都有相应的程序体系结构文档。 每个子系统的规范和设计说明书。 程序代码列表。这些列表包括程序注释、用来解释代码中复杂
代码段和采用的编码方法等。 描述每个程序怎样验证和验证信息与需求之间关系的验证文档。 维护指导文档，主要描述系统已知的问题、软件支持、硬件支
10.4.5 项目设计报告
包括以下内容 :
(1) 系统概述。 (2) 系统总体结构。 (3) 计算机系统配置方案。 (4) 代码设计。 (5) 文件/数据库设计。 (6) 输入输出设计。 (7) 计算机处理过程设计。 (8) 接口及通信环境设计。 (9) 安全保密设计。 (10)数据准备。 (11)系统测试计划。 (12)培训计划。
(3) 问题解释：解释了系统使用中可能出现的问题及 解决办法，如非常规操作命令、系统恢复过程及意 外情况、与开发单位的联系方式等。
10.4.9 项目评价报告
包括以下内容 :
(1) 概述。 (2) 系统构成。 (3) 系统达到设计目标的情况。 (4) 系统的可靠性、安全性、保密性、可维护性
10.1.1 项目文档管理的概念
概念属性：
能作为开发组员之间交流沟通的媒介。 能为软件项目的维护工程师提供有关信息系统的资
料和知识库。 能为项目管理者提供项目计划、预算、开发进度等
各方面的信息。 能作为最终用户或管理员的用户手册，使用户知道
如何使用、维护及管理系统。
10.1.2 项目文档的分类
10.4.3 项目开发计划报告
包括以下内容 :
(1)概述：主要包括系统开发的主要目标、基本方针、参 加人员、工作阶段和内容等。
(2)开发计划：系统开发各个工作阶段或者子项目的划分、 任务、分工、负责人、计划时间(开始及结束时间)、人力 资源需求、资金及设备消耗、实际执行情况等。可以用 工作进度表、甘特图、网络图及关键路径法等工具辅助 管理。
10.1.4 产品文档
系统评估员 系统管理员
新用户
老用户
系统管理员
功能性描述 安装描述 初级使用手册 参考手册 系统管理员向导
描述提供 的服务
怎样安 装系统
如何开始 所有系统功能 如何操作和
使用系统 的详细描述
维护系统
图10.1 需要随软件系统发布而产生的部分用户文档
10.1.4 产品文档
系统文档包括：
障的解决方案等。 (5) 测试结果：测试的实际情况。 (6) 结论：项目功能评价、性能技术指标评价、结论。
10.4.8 项目使用与维护手册
包括以下内容 :
(1) 概述：主要包括系统功能、系统运行环境(软硬 件环境)、系统安装等内容。
(2) 使用说明：系统操作使用说明较为详细地说明了 操作的目的、过程、方式、输入输出的数据等。最 好将系统操作的界面图放入说明书中，便于使用者 学习与操作。
是否被同意：N/A CM _ID：
图10.2 项目文档封面的主要信息
10.2.2 文档标准
包括：
过程标准：这种标准定义了高质量文档应该 遵守的过程。
产品标准：这种标准操纵文档本身。 交互标准：通过电子邮件和文档数据库交换
文档变得越来越重要，交互标准使得所有的 文档都存在可比性。
10.2.2 文档标准
持等信息，以便维护时使用。
10.2 项目文档的质量
10.2.1 项目文档结构 10.2.2 文档标准 10.2.3 文档书写风格
ቤተ መጻሕፍቲ ባይዱ
10.2.1 项目文档结构
主要信息：
标题： 项目： 文档ID： 文档类型： 版本： 作者： 是否被检查： 是/否 提交给CM： 发布： 密级： 关键词：
日期：
工作文档：这些文档是在项目开发中最主要的交流沟通工具， 记录了软件项目开发中软件工程师的想法等。
备忘录及电子信息：主要记录了每天项目经理和开发人员之间 的详细交流信息。
10.1.4 产品文档
产品文档可以分为用户文档和系统文档：
用户文档包括：
(1) 系统功能描述 (2) 初级使用手册 (3) 系统参考手册 (4) 系统安装文档 (5) 系统管理员手册
(3)验收标准：每项工作完成后验收的标准，包括时间、 资金、质量等。
(4)协调方法：项目开发中各个单位、阶段之间的衔接、 协调方法、负责人、权限等。
10.4.4 项目分析报告
包括以下内容 :
(1) 概述。 (2) 系统需求。 (3) 新系统的目标与新鲜系统的功能。 (4) 新系统的逻辑模型。 (5) 新系统的运行环境。 (6) 新系统的验收标准与培训计划。
10.4.6 程序设计报告
包括以下内容 :
(1) 概述。 (2) 程序结构图。 (3) 程序控制图。 (4) 算法。 (5) 程序流程图。 (6) 源程序。 (7) 程序注释及说明。
10.4.7 项目测试报告
包括以下内容 :
(1) 概述：说明项目测试的目的。 (2) 测试环境：有关软、硬件、通信、数据库、人员等情况。 (3) 测试内容：系统、子系统、模块的名称、性能技术指标等。 (4) 测试方案：测试的方法、测试数据、测试步骤、测试中故
10.1.3 过程文档
过程文档可以分为如下几类：
软件项目计划、预测和进度安排文档：这些文档由项目经理负 责产生，以便预测和控制软件的开发过程。
相关报告：这些文档用来报告在软件开发过程中，资源是如何 分配和利用的。
标准报告：这些文档规定了软件过程应该如何实现，这些可以 是国际标准、国家标准、行业标准等。
编写最初文档
评审文档
整理评审意见
修改文档
阶段1：编制 校对文字
阶段2：修改
最终文档
确认最终文档
设计文档 阶段3：发布
复审文档
打印文档
图10.3 文档编制过程
打印备份文档
10.2.3 文档书写风格
编写文档时，也应该注意以下问题：
运用主动的而不是被动的语气。 运用正确的术语和语法结构。 句子不宜过长，尽量用短句。 段落简短。 用词简洁，不要长篇累犊。 简明定义用到的专业术语。 应用标题和子标题。 尽可能地逐条列举事实。 不要单纯地参考数字、图、表来理解信息，应当有一
10.4.1 项目开发立项报告
包括以下内容 :
(1) 概述：概述现行系统的组织结构、功能、业务流程以 及存在的主要问题。
(2) 新系统的目标：开发新系统的意义和新系统实现后的 功能、技术指标、安全和保密性、新系统运行环境等。
(3) 经费预测和经费来源。 (4) 项目进度和完成期限。 (5) 验收标准和方法。 (6) 移交的文档资料。 (7) 开始可行性研究的组织队伍、机构与预算。 (8) 其他需要说明的有关问题。
等状况。 (5) 系统的经济效益与社会效益的评价。 (6) 总结性评价。
10.4.10 项目开发总结报告
包括以下内容 :
(1) 概述：包括项目的提供者、开发者、用户；项目开发的 主要依据；项目开发的目的；项目开发的可行性分析等。
(2) 项目的完成情况：包括项目构成与主要功能；项目性能 与技术指标；计划与实际进度对比；费用预算与实际费用 的对比等。
文档索引
文档数据库 图10.4 文档管理
10.4 主要项目文档
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 项目开发总结报告