开发文档介绍.pdfVIP

开发文档介绍 软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效 率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其 在维护工作中，文档是不可或缺的资料。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括： 《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、 《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项 目总结》等。 产品文档包括： 《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。用户文档《安装手册》 、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。 开发文档 1. 《功能要求》 -- 来源于客户要求和市场调查， 是软件开发中最早期的一个环节。 客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的 一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部 列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》 -- 根据用户的功能要求，经过与招标方沟通和确认，技术人员开 始书写《投标方案》 ，方案书一般包括以下几个重要的章节： 前言 -- 项目背景、 公司背景和业务、 技术人员结构、 公司的成功案例介绍等。 需求分析 -- 项目要求、 软件结构、 功能列表、 功能描述、 注意事项等。 技术方案 -- 总体要求和指导思想、 技术解决方案、 软件开发平台、 网络结构体系等。 项目管理 -- 描述公司的软件开 发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验 收和人员培训、 软件资料文档等。 技术支持 -- 公司的技术支持和服务介绍、服务 宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系 人等。 系统报价 -- 软、硬件平台报价列表、 软件开发费用、 系统维护费用等。 项 目进度 -- 整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、 程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 3. 《需求分析》 -- 包括产品概述、主要概念、操作流程、功能列表和解说、注意 事项、系统环境等。以《功能要求》为基础，进行详细的功能分析 ( 包括客户提出 的要求和根据开发经验建议的功能 ) ，列出本产品是什么， 有什么特殊的概念， 包 括哪些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么 细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手 册是一致的。 4. 《技术分析》 -- 包括技术选型、技术比较、开发人员、关键技术问题的解决、 技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》 为基础，进行详细的技术分析 ( 产品的性能和实现方法 ) ，列出本项目需要使用 什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难， 技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》 -- 包括功能实现、模块组成、功能流程图、函数接口、数据字典、 软件开发需要考虑的各种问题等。 以 《需求分析》为基础，进行详细的系统分析 ( 产 品的开发和实现方法 ) ，估计开发期间需要把什么问题说明白， 程序员根据 《系统