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

《开发文档主要的内容及介绍》由会员分享，可在线阅读，更多相关《开发文档主要的内容及介绍（3页珍藏版）》请在装配图网上搜索。

1、开发文档主要的内容及介绍开发文档包括：1、功能要求来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功 能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还 会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。 这份文档是需求分析的基础。2、投标方案根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写投标方案，方 案书一般包括以下几个重要的章节：前言-项目背景、公司背景和业务、技术人员结构、 公司的成功案例介绍等。需求分析-项目要求、软件结构、功能列表、功能描述、注意 事项等。技术方案-总体要求和指导思想

2、、技术解决方案、软件开发平台、网络结构体 系等。项目管理-描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。技术支持-公司的技 术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、 授权用户联系人等。系统报价-软、硬件平台报价列表、软件开发费用、系统维护费用 等。项目进度-整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、 程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。3、需求分析包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以功 能要求

3、为基础，进行详细的功能分析（包括客户提出的要求和根据开发经验建议的功 能），列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能， 该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。 这里的功能描述跟以后的使用手册是一致的。4、技术分析包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、 技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析（产 品的性能和实现方法），列出本项目需要使用什么技术方案，为什么，有哪些技术问题要 解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评

4、 价等。5、系统分析包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各 种问题等。以需求分析为基础，进行详细的系统分析（产品的开发和实现方法），估 计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带领下进 行编码。6、数据库文档包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。 以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据 库。7、功能函数文档包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系 统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修

5、改、 接手和扩展。8、界面文档包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里 与软件完成后的运行界面是一致的。9、编译手册包括服务器编译环境、操作系统、编译工具、GNU的C+编译器版本信息、目录说 明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的 编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装 程序的过程。10、QA文档包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结 构、测试要求等，提供给软件测试人员使用。11、项目总结等包括项目简介、项目参与人员和开发时间、项

6、目风险管理过程、项目功能列表、项目 结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。产品文档包括：1、产品简介包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。2、产品演示包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功 能模块、解决问题、合作伙伴、成功案例等。一般用Power point或者VCD录制软件实现。3、疑问解答列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题4、功能介绍以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联 系地址。5、技术白皮书以技术分析为

7、书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方 案特点、技术升级方向等。6、评测报告 I J第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性 能表现、结果分析和评测总结等。7、安装手册包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。8、使用手册包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。9、维护手册包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解 答和联系方式等。10、用户报告包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和 解决、产品总结和建议等。11、销售培训包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户 等。