-第四讲项目文档.ppt

项目文档概述 文件内容的格式标准化 － 写八股文 项目初始资料 项目计划 、、、 模型设计 技术文档 　　技术文档可分类为： 技术描述文档：与详细设计类似 工艺流程框图：用UML工具 操作范例文件：已经是标准格式 文档模板例子：其它文档的标准 ? 技术文档可以标准化 测试文档及错误报告 、、、 bjhk * 项目文档概述 文件内容的格式标准化 － 写八股文 项目初始资料 项目计划 、、、 技术文档 测试报告及错误报告 在产品试运行前，要对其在运行时的状态进行描述，从而 使得测试人员根据此报告的内容判断测试结果，如果发现 错误，则填写相应内容。通常如下（也有相应的软件）： 运行前的状态 运行中的情况 运行后的结果（正常或错误报告） 　　? 测试报告及错误报告可以标准化 错误报告（投入使用时发现的） 、、、 bjhk * 项目文档概述 文件内容的格式标准化 － 写八股文 项目初始资料 项目计划 、、、 测试报告及错误报告 错误报告（投入使用时发现的） 这项报告和前面的错误报告是一样的。 ? 错误报告可以标准化 新的客户需求（升级报告） 由于市场、产品、政策等的变化，可能项目也要进行相应的 改动。或者由于客户的疏忽而遗漏的要求，也必须对项目进 行改动。新需求由客户提出，将以文本带附件的形式给出。 附件是原始资料，无法统一。而需求描述的文本可以和客户 商议，制定统一格式。 ? 新的客户需求可以标准化 bjhk * 项目文档概述 文件内容的格式标准化 － 写八股文 项目初始资料 项目计划 第2讲 会议记录 第2讲 需求文档（应用描述） 第3讲 概要设计／详细设计 第3讲 模型设计 技术文档 第3讲 测试报告及错误报告 第3讲 错误报告 第3讲 新的客户需求 bjhk * 项目文档概述 下述文档通常是“一份” 项目计划 需求文档（应用描述） 概要设计 模型设计 其它文档通常是多份 会议记录 技术文档 测试报告及错误报告 错误报告 新的客户需求 bjhk * 内容 项目文档概述 需求文档、设计文档、技术文档 测试报告、错误报告 bjhk * 需求文档、设计文档、技术文档 文档格式 上述的三种文档的格式，其第一页要包括文件修改记录， 第二页是目录，其后是附件或附图列表，然后是正文。 第一页的内容如下： 徽标（Logo）：至少有一个徽标，及公司名称 项目名称、简称或代号 文件标题，以及副标题 修改记录，用表格的方式记录，内容是： 修改者姓名、简称（三个字母） 修改日期：yyyy.mm.dd（不要用短格式） 修改类型：创建、改动、检查（校对） 修改说明：改动的内容 页脚处是文档的文件名和页号及总页数 bjhk * 需求文档、设计文档、技术文档 第二页是目录 其后是附件（或附图）列表 然后是正文 正文的第一个章节总是概述，后面的章节才是实际内容。 概述通常可能是下面内容： 背景、原因、目的 范围、限制、扩展 相关资料、信息　 bjhk * 需求文档、设计文档、技术文档 文件名称 因为上述三类文档会被多次改动，而通常情况下需要保留其 修改过程（历史资料）。可以使用资料管理器，一种专门用 于项目管理的软件。 简单的方法是： 先复制原文件 将复制得到的文件名改为：原文件名 + 上次改动日期 然后修改原文件 说明：上次改动日期在文件的第一页有记录 例如：文件“MES管理系统需求说明.doc”上次在2011.10.10被改动。 我们在这次改动前先将文件复制，并命名为： “MES管理系统需求说明 2011.10.10.doc” 然后开始改动原文件“MES管理系统需求说明.doc” bjhk * 公共文件管理 文件内容的格式标准化 － 写八股文 应用描述文档 　　应用描述的第二页开始是正式内容，包括 内容目录 插图目录（如果有需要） 附件列表（如果有附件） 第一章是概述或简介，可能的内容是： 背景 原因 范围 目的 限制 扩展 第二章开始是实际内容 文件标准化（写八股文） 　　从宋朝就开始逐渐形成八股文 　　现代社会到处都是标准文，如法律、行政、交通等 bjhk * 需求文档、设计文档、技术文档 表达形式的分类 用文字以段落形式描述 用图片的展示 用表格的形式描述 用流程图展示 用数据表表达 用具体的计算公式表达 用数据表给出的规则 用行业术语、符号、图标描述的规则 相关信息的描述 参考资料列表 互联网的链接地址 相互影响的、依赖的、隐含的业务 bjhk * 需求文档、设计文档、技术文档 需求文档的内容 业务的分布 相关人员的分布 主要事件处理方法 技术框架 机器的分布（设备、仪器、工具） bjhk * 需求文档、设计文档、技术文档 需求文档的内容 － 业务的分布 介绍系统可以处理那些商务事件，例如： bjhk * 需求文