IT项目管理人员必备的软件知识.docx

软件文档知多少？ 如今，软件开发越来越复杂，软件功能也越来越丰富。 而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力 的血汗结晶。 “罗马不是一天建成的！ ”，当我们震撼于 Microsoft Windows 的惊世巨著的同时， 也道听途说了微软公 司软件工程是如何的完善规范。的确，集数百名员工几年的 共同努力之大成，软件项目管理的成败是控制开发成本的关 键环节。这里面，少不了贯穿其中的重要步骤 软件文档。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括： 《功能要求》 、《投标方案》 、《需求分析》 、 《技术分析》 、《系统分析》 、《数据库文档》 、《功能函数文档》 、 《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》 、《产品演示》 、《疑问解答》 、 《功能介绍》 、《技术白皮书》 、《评测报告》 、《安装手册》 、《使 用手册》、《维护手册》 、《用户报告》 、《销售培训》等。 一、开发文档 《功能要求》 -- 来源于客户要求和市场调查，是软件 开发中最早期的一个环节。客户提出一个模糊的功能概念， 或者要求解决一个实际问题，或者参照同类软件的一个功 能。有软件经验的客户还会提供比较详细的技术规范书，把 他们的要求全部列表书写在文档中，必要时加以图表解说。 这份文档是需求分析的基础。 《投标方案》 -- 根据用户的功能要求，经过与招标方 沟通和确认，技术人员开始书写《投标方案》 ，方案书一般 包括以下几个重要的章节： 前言 --项目背景、公司背景和业务、技术人员结构、公 司的成功案例介绍等。 需求分析 -- 项目要求、软件结构、功能列表、功能描述、 注意事项等。 技术方案 --总体要求和指导思想、技术解决方案、软件 开发平台、网络结构体系等。 项目管理 --描述公司的软件开发流程、工程实施服务、 组织和人员分工、开发进度控制、软件质量保证、项目验收 和人员培训、软件资料文档等。 技术支持 --公司的技术支持和服务介绍、服务宗旨和目 标、服务级别和响应时间、技术服务区域、技术服务期限、 授权用户联系人等。 系统报价 --软、硬件平台报价列表、软件开发费用、系 统维护费用等。 项目进度 --整个项目的进度计划，包括签署合同、项目 启动、需求分析、系统分析、程序开发、测试维护、系统集 成、用户验收、用户培训等步骤的时间规划。 《需求分析》 --包括产品概述、主要概念、操作流程、 功能列表和解说、注意事项、系统环境等。以《功能要求》 为基础， 进行详细的功能分析 （包括客户提出的要求和根据开 发经验建议的功能 ），列出本产品是什么， 有什么特殊的概念， 包括那些功能分类， 需要具备什么功能， 该功能的操作如何， 实现的时候该注意什么细节，客户有什么要求，系统运行环 境的要求等。这里的功能描述跟以后的使用手册是一致的。 《技术分析》 --包括技术选型、技术比较、开发人员、 关键技术问题的解决、技术风险、技术升级方向、技术方案 评价，竞争对手技术分析等。以《需求分析》为基础，进行 详细的技术分析 （产品的性能和实现方法 ），列出本项目需要 使用什么技术方案，为什么，有哪些技术问题要解决，估计 开发期间会碰到什么困难，技术方案以后如何升级，对本项 目的技术有什么评价等。 《系统分析》 -- 包括功能实现、模块组成、功能流程 图、函数接口、 数据字典、 软件开发需要考虑的各种问题等。 以《需求分析》为基础，进行详细的系统分析 （产品的开发和 实现方法 ），估计开发期间需要把什么问题说明白， 程序员根 据《系统分析》 ，开始在项目主管的带领下进行编码。 《数据库文档》 -- 包括数据库名称、表名、字段名、 字段类型、字段说明、备注、字段数值计算公式等。以《系 统分析》为基础，进行详细的数据库设计。必要时可以用图 表解说，特别是关系数据库 《功能函数文档》 --包括变量名、变量初植、功能， 函数名，参数，如何调用、备注、注意事项等。以《系统分 析》为基础，进行详细的说明，列出哪个功能涉及多少个函 数，以便以后程序员修改、接手和扩展。 《界面文档》 --包括软件外观、界面素材、编辑工具、 文件名、菜单、按钮和其它界面部件的要求，这里与软件完 成后的运行界面是一致的。 《编译手册》 -- 包括服务器编译环境、操作系统、编 译工具、GNU的C++编译器版本信息、目录说明、程序生成、 源程序文件列表、 Makefile 配置及其相关程序的对应关系列 表。客户端的编译过程、编译结果、编译示例、编译环境、 操作系统、编译工具、源文件列表和制作安装程序的过程。 《QA 文档》 --包括产品简介、产品原理、产品功能 列表、功能描述、功能流程、执行结果、数据库结构、测试 要求等，提供给软件测试人员使