项目文档知多少ABC

《项目文档知多少ABC》由会员分享，可在线阅读，更多相关《项目文档知多少ABC（33页珍藏版）》请在金锄头文库上搜索。

1、Iocri China 41 I BEIJING项目文档知道少ESRI中国（北京）有限公司2013年5月Iocri China41 I BEIJING版权声明本文档版权为ESRI中国（北京）有限公司所有。未经本公司书 面许可，任何单位和个人不得以任何形式摘抄、复制本文档的部分或 全部，并以任何形式传播。Iocri China 41 I BEIJING1为什么要文档？在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件 文档在产品的开发生产过程中起着重要的作用。1）提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的 形式记录在文档中。管理人员可把这些记载下来的材料作为检

2、查软件开发进度和 开发质量的依据，实现对软件开发的工程管理。2）提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进 行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性， 便于及时加以纠正。3）作为开发人员在一定阶段的工作成果和结束标志。4）记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。5）提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、 操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。6）便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己 需要的软件提供依据。2有哪几类文档？2.1按照文档产生和

3、使用的范围分3类2.1.1开发文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档，包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明、可行性研究报告和项目开发计划。2.1.2管理文档是在软件开发过程中，由软件开发人员制定的需提交的一些工作计划或工作Iocri China 41 I BEIJING报告，使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和 成果等，包括项目开发计划、测试计划、测试报告、开发进度月报及 项目开发总结。2.1.3用户文档是软件开发人员为用户准备的有关该软件使用、操作和维护的资料，包括用 户手册、操作手册、维

4、护修改建议和软件需求说明书。2.2按照文档的性质可以分2类2.2.1开发文档开发文档包括：功能要求、投标方案、需求分析、技术分析、系 统分析、数据库文档、功能函数文档、界面文档、编译手册、QA文 档、项目总结等。2.2.1.1功能要求来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一 个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。 有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写 在文档中，必要时加以图表解说。这份文档是需求分析的基础。2.2.1.2投标方案根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写投标 方案，方

5、案书一般包括以下几个重要的章节：前言-项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。需求分析-项目要求、软件结构、功能列表、功能描述、注意事项等。技术方案-总体要求和指导思想、技术解决方案、软件开发平台、网络结构 体系等。Iocri China 41 I BEIJING项目管理-描述公司的软件开发流程、工程实施服务、组织和人员分工、开 发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。技术支持-公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应 时间、技术服务区域、技术服务期限、授权用户联系人等。系统报价-软、硬件平台报价列表、软件开发费用、系统维护费用等。项

6、目进度-整个项目的进度计划，包括签署合同、项目启动、需求分析、系 统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规 划。2.2.1.3需求分析包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环 境等。以功能要求为基础，进行详细的功能分析（包括客户提出的要求和根 据开发经验建议的功能），列出本产品是什么，有什么特殊的概念，包括那些功 能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节， 客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是 一致的。2.2.1.4技术分析包括技术选型、技术比较、开发人员、关键技术问题的解决、

7、技术风险、技 术升级方向、技术方案评价，竞争对于技术分析等。以需求分析为基础，进 行详细的技术分析（产品的性能和实现方法），列出本项目需要使用什么技术方 案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方 案以后如何升级，对本项目的技术有什么评价等。2.2.1.5系统分析包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需 要考虑的各种问题等。以需求分析为基础，进行详细的系统分析（产品的开 发和实现方法），估计开发期间需要把什么问题说明白，程序员根据系统分析，Iocri China 41 I BEIJING开始在项目主管的带领下进行编码。2.2.1.6数据库文档

8、包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计 算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表 解说，特别是关系数据库。2.2.1.7功能函数文档包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项 等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数， 以便以后程序员修改、接手和扩展。2.2.1.8界面文档包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件 的要求，这里与软件完成后的运行界面是一致的。2.2.1.9编译手册包括服务器编译环境、操作系统、编译工具、GNU的C+编译器版本信息、 目录说明、程序生成、

9、源程序文件列表、Makefile配置及其相关程序的对应关系 列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工 具、源文件列表和制作安装程序的过程。2.2.1.10QA文档包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、 数据库结构、测试要求等，提供给软件测试人员使用。Iocri China 41 I BEIJING2.2.1.11项目总结包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列 表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员 素质情况等。2.2.2产品文档产品文档包括：产品简介、产品演示、疑问解答、功能

10、介绍、技 术白皮书、评测报告、安装手册、使用手册、维护手册、用户报 告、销售培训等。2.2.2.1产品简介包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公 司联系地址。2.2.2.2产品演示包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使 用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Power point或 者VCD录制软件实现。2.2.2.3疑问解答列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑 难问题。2.2.2.4功能介绍以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描 述和公司联系地址。Iocri Chi

11、na41 I BEIJING2.2.2.5技术白皮书以技术分析为书写基础，包括功能实现、技术选型、关键技术问题的解 决、技术方案特点、技术升级方向等。2.2.2.6评测报告第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实 测数据、性能表现、结果分析和评测总结等。2.2.2.7安装手册包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。2.2.2.8使用手册包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方 式等。2.2.2.9维护手册包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技 术问题解答和联系方式等。2.2.2.10用户报告

12、包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出 现问题和解决、产品总结和建议等。2.2.2.11销售培训包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、Iocri China 41 I BEIJING目标客户等。3文档参照标准？GB 8566-88计算机软件开发规范GB 8567-88计算机软件产品开发文件编制指南GB/T 11457-1995软件工程术语ISO 质量认证体系：ISO 9000-1，ISO 9001，ISO 9002, ISO 9003, ISO 9004-14项目流程及输出文档4.1可行性与计划研究阶段4.1.1输出文档：可行性研究报告

13、在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行 可行性分析、投资-收益分析、制订开发计划，并完成应编制的文件。4.1.2输出文档：项目开发计划编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的 负责人员、开发进度、所需经费预算、所需软、硬件条件等问题做出的安排记 载下来，以便根据本计划开展和检查本项目的开发工作。4.2需求分析阶段4.2.1输出文档：软件需求说明书软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规 定有一个共同的理解，使之成为整个开发工作的基础。内容包括对功能的规定Iocri China 41 I BEIJING对性能的规定等。

14、4.2.2输出文档：数据要求说明书数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的 描述和数据采集要求的技术信息。4.2.3输出文档：用户手册（初稿）用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有 的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的 用途，并且能够确定在什么情况下，如何使用它。4.3设计阶段4.3.1输出文档：概要设计说明书概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。编 制的目的是说明对程序 系统的设计考虑，包括程序系统的基本处理流程、程序 系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结

15、构设计 和出错处理设计等，为程序的详细设计提供基础。4.3.2输出文档：详细设计说明书详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个 层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比 较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书。4.3.3输出文档：数据库设计说明书数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构 和物理结构做出具体的设计规定。Iocri China 41 I BEIJING4.3.4输出文档：测试计划（初稿）这里所说的测试，主要是指整个程序系统的组装测试和确认测试。本文件的 编制是为了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安 排、设计考虑、测试数据的整理方法及评价准则。4.4实现阶段4.4.1输出文档：模