开发文档主要的内容及介绍开发.docVIP

?? 开发文档重要的内容及简介

开发文档包含：

1、《功效规定》

起源于客户规定和市场调查,是软件开发中最初期的一个环节。客户提出一个含糊的功效概念,或者规定解决一个实际问题,或者参考同类软件的一个功效。有软件经验的客户还会提供比较具体的技术规范书，把他们的规定全部列表书写在文档中，必要时加以图表讲解。这份文档是需求分析的基础。

2、《投标方案》

?依照用户的功效规定，经过与招标方沟通和确认,技术人员开始书写《投标方案》，方案书通常包含如下几种重要的章节：前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例简介等。需求分析--项目规定、软件结构、功效列表、功效描述、注意事项等。技术方案－-总体规定和指导思想、技术解决方案、软件开发平台、网络结构体系等。项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。技术支持--公司的技术支持和服务简介、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联络人等。系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。项目进度--整个项目标进度计划，包含签署协议、项目开启、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等环节的时间规划。

3、《需求分析》

包含产品概述、重要概念、操作流程、功效列表和讲解、注意事项、系统环境等。以《功效规定》为基础，进行具体的功效分析(包含客户提出的规定和依照开发经验建议的功效)，列出本产品是什么，有什么特殊的概念，包含那些功效分类，需要具备什么功效,该功效的操作如何，实现的时候该注意什么细节,客户有什么规定,系统运营环境的规定等。这里的功效描述跟以后的使用手册是一致的。

4、《技术分析》

包含技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础,进行具体的技术分析（产品的性能和实现方法)，列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决，估量开发期间会碰到什么困难，技术方案以后如何升级,对本项目标技术有什么评价等。

５、《系统分析》

?包含功效实现、模块构成、功效流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行具体的系统分析(产品的开发和实现方法),估量开发期间需要把什么问题阐明白,程序员依照《系统分析》，开始在项目主管的率领下进行编码。

6、《数据库文档》

?包含数据库名称、表名、字段名、字段类型、字段阐明、备注、字段数值计算公式等。以《系统分析》为基础,进行具体的数据库设计。必要时可以用图表讲解,特别是关系数据库。

7、《功效函数文档》

?包含变量名、变量初植、功效，函数名,参数，如何调用、备注、注意事项等。以《系统分析》为基础,进行具体的阐明,列出哪个功效涉及多少个函数,以便以后程序员修改、接手和扩展。

８、《界面文档》

包含软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的规定,这里与软件完成后的运营界面是一致的。

9、《编译手册》

包含服务器编译环境、操作系统、编译工具、GＮU的C＋+编译器版本信息、目录阐明、程序生成、源程序文件列表、Maｋｅｆile配备及其相关程序的相应关系列表。客户端的编译过程、编译成果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

１０、《QA文档》

包含产品简介、产品原理、产品功效列表、功效描述、功效流程、执行成果、数据库结构、测试规定等,提供应软件测试人员使用。

1１、《项目总结》等

包含项目简介、项目参加人员和开发时间、项目风险管理过程、项目功效列表、项目结构特点、技术特点、对项目标升级建议、对以后的项目标建议、人员素质情况等。

产品文档包含：

1、《产品简介》

包含公司背景、产品概念、合用范围、产品功效、功效特点、运营规定和公司联络地址。

2、《产品演示》

包含公司简介、产品背景、产品描述、产品特点、产品作用、合用范围、使用分析、功效模块、解决问题、合作搭档、成功案例等。通常用Ｐowerpｏiｎt或者ＶCD录制软件实现。

3、《疑问解答》

列出用户关心的问题和解决方法。用于解答软件的操作功效和解决用户的疑难问题

4、《功效简介》

以《需求分析》为书写基础，包含软件简介、软件结构、功效列表、功效描述和公司联络地址。

５、《技术白皮书》

以《技术分析》为书写基础，包含功效实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

6、《评测报告》