第四讲项目文档设计

2011.11.06上午1第四讲项目文档设计2011.11.06上午2内容•项目文档概述•需求文档、设计文档、技术文档•测试报告、错误报告2011.11.06上午3内容•项目文档概述•需求文档、设计文档、技术文档•测试报告、错误报告2011.11.06上午4•项目文档概述–从文件存储格式分类有：•文本文件－.doc,.txt,.xls•阅读文件－.pdf,.htm,.html•图像文件－.bmp,.jpg,.gif,.png等•数据文件－.mdb,.xml•录音录像－多媒体文件•其它文件－工具文件，如UML等•、、、2011.11.06上午5•项目文档概述–从文件内容分类有：•项目初始资料•项目计划•会议记录•需求文档（应用描述）•概要设计／详细设计•模型设计•技术文档•测试报告及错误报告•错误报告（投入使用时发现的）•新的客户需求（升级报告）2011.11.06上午6•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•会议记录•需求文档（应用描述）•概要设计／详细设计•模型设计•技术文档•测试报告及错误报告•错误报告（投入使用时发现的）•新的客户需求（升级报告）2011.11.06上午7•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料项目在开始启动前有一些事情是已经确定了，最基本的资料至少包括如下内容：–项目的发起人（或企业、单位）–项目的承担人（或企业、单位）–可行性和成本及效益–应用的简单描述，其形式为：»文本：电子版、打印件或手写稿»图片：电子版、印刷件或手画件»录音：电子版、CD/DVD»录像：电子版、CD/DVD–前期资金预算（Budget）到位这些资料通常是多种多样的，故工程初始资料被认定为无法标准化。•项目计划•……2011.11.06上午8•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划项目计划是规划各个阶段的工作任务，和参加的人员，及每个人的时间段及任务内容。项目计划通常由双方协商确定，当然主要由项目承担者来规划。有软件可用来规划项目，例如微软的Project程序。也可用文本书写软件来描述，例如Word或Excel。项目计划书可标准化•会议记录•、、、2011.11.06上午9•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•会议记录在项目实施过程中，对计划常常要进行小的改动，每个人的工作也要更详细的确定，一些问题要经过大家一起讨论，也要考察工程的进度和质量，技术方面的标准要统一，等等事情都要通过开会来交流和协商，会议的内容要被清楚的记录，以备随时查看。会议记录通常是用文档编辑软件书写，例如用Word。会议的参与者是与工程相关的人员，所以可以按统一格式来记录内容，以方便以后阅读。会议记录可以标准化•需求文档（应用描述）•、、、2011.11.06上午10•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•会议记录•需求文档（应用描述）需求文档描述文档的内容主要涉及一些方面：–何人使用：什么人用它来工作、娱乐、处理事情–使用环境：什么设施、设备、仪器、工具–产品功能：每类人使用那些功能–附加说明：解释某些问题、事情的附带文件当我们把文档的内容事先已经能确定下来的话，那么其格式也就可事先规定好。需求文档（应用描述）可以标准化•概要设计／详细设计•、、、2011.11.06上午11•项目文档概述–文件内容的格式标准化－写八股文•工程初始资料•项目计划•会议记录•需求文档（应用描述）•概要设计／详细设计概要设计描述项目的总技术和总实施方案；详细设计描述具体的施工方法，包括–对每个工具的详细说明–对每个材料的详细说明–对每个工艺及流程的详细说明–、、、概要设计／详细设计可以标准化•模型设计•、、、2011.11.06上午12•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•会议记录•需求文档（应用描述）•概要设计／详细设计•模型设计–模型设计主要是项目中的数据模型的描述。–模型设计通常用UML工具完成。–某些行业也有专门的软件工具作模型设计。模型设计可以标准化•技术文档•、、、2011.11.06上午13•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•、、、•模型设计•技术文档技术文档可分类为：–技术描述文档：与详细设计类似–工艺流程框图：用UML工具–操作范例文件：已经是标准格式–文档模板例子：其它文档的标准技术文档可以标准化•测试文档及错误报告•、、、2011.11.06上午14•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•、、、•技术文档•测试报告及错误报告在产品试运行前，要对其在运行时的状态进行描述，从而使得测试人员根据此报告的内容判断测试结果，如果发现错误，则填写相应内容。通常如下（也有相应的软件）：–运行前的状态–运行中的情况–运行后的结果（正常或错误报告）测试报告及错误报告可以标准化•错误报告（投入使用时发现的）•、、、2011.11.06上午15•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划•、、、•测试报告及错误报告•错误报告（投入使用时发现的）这项报告和前面的错误报告是一样的。错误报告可以标准化•新的客户需求（升级报告）由于市场、产品、政策等的变化，可能项目也要进行相应的改动。或者由于客户的疏忽而遗漏的要求，也必须对项目进行改动。新需求由客户提出，将以文本带附件的形式给出。附件是原始资料，无法统一。而需求描述的文本可以和客户商议，制定统一格式。新的客户需求可以标准化2011.11.06上午16•项目文档概述–文件内容的格式标准化－写八股文•项目初始资料•项目计划第2讲•会议记录第2讲•需求文档（应用描述）第3讲•概要设计／详细设计第3讲•模型设计•技术文档第3讲•测试报告及错误报告第3讲•错误报告第3讲•新的客户需求2011.11.06上午17•项目文档概述–下述文档通常是“一份”•项目计划•需求文档（应用描述）•概要设计•模型设计–其它文档通常是多份•会议记录•技术文档•测试报告及错误报告•错误报告•新的客户需求2011.11.06上午18内容•项目文档概述•需求文档、设计文档、技术文档•测试报告、错误报告2011.11.06上午19•需求文档、设计文档、技术文档–文档格式上述的三种文档的格式，其第一页要包括文件修改记录，第二页是目录，其后是附件或附图列表，然后是正文。–第一页的内容如下：•徽标（Logo）：至少有一个徽标，及公司名称•项目名称、简称或代号•文件标题，以及副标题•修改记录，用表格的方式记录，内容是：–修改者姓名、简称（三个字母）–修改日期：yyyy.mm.dd（不要用短格式）–修改类型：创建、改动、检查（校对）–修改说明：改动的内容•页脚处是文档的文件名和页号及总页数2011.11.06上午20•需求文档、设计文档、技术文档–第二页是目录–其后是附件（或附图）列表–然后是正文正文的第一个章节总是概述，后面的章节才是实际内容。概述通常可能是下面内容：–背景、原因、目的–范围、限制、扩展–相关资料、信息2011.11.06上午21•需求文档、设计文档、技术文档–文件名称因为上述三类文档会被多次改动，而通常情况下需要保留其修改过程（历史资料）。可以使用资料管理器，一种专门用于项目管理的软件。简单的方法是：•先复制原文件•将复制得到的文件名改为：原文件名+上次改动日期•然后修改原文件说明：上次改动日期在文件的第一页有记录例如：文件“MES管理系统需求说明.doc”上次在2011.10.10被改动。我们在这次改动前先将文件复制，并命名为：“MES管理系统需求说明2011.10.10.doc”然后开始改动原文件“MES管理系统需求说明.doc”2011.11.06上午22•公共文件管理–文件内容的格式标准化－写八股文•应用描述文档应用描述的第二页开始是正式内容，包括–内容目录–插图目录（如果有需要）–附件列表（如果有附件）–第一章是概述或简介，可能的内容是：»背景»原因»范围»目的»限制»扩展–第二章开始是实际内容–文件标准化（写八股文）从宋朝就开始逐渐形成八股文现代社会到处都是标准文，如法律、行政、交通等2011.11.06上午23•需求文档、设计文档、技术文档–表达形式的分类•用文字以段落形式描述•用图片的展示•用表格的形式描述•用流程图展示•用数据表表达•用具体的计算公式表达•用数据表给出的规则•用行业术语、符号、图标描述的规则–相关信息的描述•参考资料列表•互联网的链接地址•相互影响的、依赖的、隐含的业务2011.11.06上午24•需求文档、设计文档、技术文档–需求文档的内容•业务的分布•相关人员的分布•主要事件处理方法•技术框架•机器的分布（设备、仪器、工具）2011.11.06上午25•需求文档、设计文档、技术文档–需求文档的内容－业务的分布介绍系统可以处理那些商务事件，例如：2011.11.06上午26•需求文档、设计文档、技术文档–需求文档的内容－业务的分布也可以按事物的类分成不同模块，例如：2011.11.06上午27•需求文档、设计文档、技术文档–需求文档的内容－相关人员的分布介绍哪些人出现在商务事件中，例如：2011.11.06上午28•需求文档、设计文档、技术文档–需求文档的内容－主要事件处理方法通过数据的分布来表示，例如：2011.11.06上午29•需求文档、设计文档、技术文档–需求文档的内容－主要事件处理方法通过工作的流程来表示，例如：2011.11.06上午30•需求文档、设计文档、技术文档–需求文档的内容－技术框架通过各层次的功能模块表示，例如：2011.11.06上午31•需求文档、设计文档、技术文档–需求文档的内容－技术框架通过各模块的运行原理表示，例如：2011.11.06上午32•需求文档、设计文档、技术文档–需求文档的内容－机器的分布软件中最主要是服务器和数据库，例如：2011.11.06上午33•需求文档、设计文档、技术文档–设计文档的内容•功能模块的描述•模块接口的描述•模块实施的过程•模块连接的过程•、、、2011.11.06上午34•需求文档、设计文档、技术文档–设计文档的内容－功能模块的描述例如某大楼的排水功能应达到：•降雨量为10cm时，住户无堵水感觉•降雨量为20cm时，住户有小堵水感觉•降雨量为30cm时，住户有大堵水感觉•降雨量为40cm时，住户有倒流水感觉2011.11.06上午35•需求文档、设计文档、技术文档–设计文档的内容－模块接口的描述例如某大楼的排水管接口为：•各住户有一个直径20cm通往大楼排水管的主排水管接口•主排水管有四个直径10cm与的次排水管接口，分别在：–厨房–洗手间–浴室–阳台•每个次排水管有五个5cm的小排水管接口2011.11.06上午36•需求文档、设计文档、技术文档–设计文档的内容－模块实施的过程例如某大楼的主、次排水管的安装方法：•A型住宅主排水管安装按图101操作。•B型住宅主排水管安装按图102操作。•C型住宅主排水管安装按图103操作。•厨房次水管安装按图201操作。•浴室次水管安装按图202操作。•阳台次水管安装按图203操作。•洗手间次水管安装按图204操作。2011.11.06上午37•需求文档、设计文档、技术文档–设计文档的内容－模块连接的过程例如某大楼的主、次排水管的连接的方法：•图101中使用X123套管、15号螺丝、螺帽，15号板子•图102中使用X124套管、15号螺丝、螺帽，15号板子。•图103中使用X123套管、15号螺丝、螺帽，15号板子•图201中使用X1235套管、10号螺丝、螺帽，10号板子•图202中使用X1235套管、10号螺丝、螺帽，10号板子•图203中使用X1235套管、10号螺丝、螺帽，10号板子•图204中使用X1235套管、10号螺丝、螺帽，10号板子2011.11.06上午38•需求文档、设计文档、技术文档–技术文档