软体开发文档详细资料大全
软体开发文档是软体开发使用和维护过程中的必备资料。它能提高软体开发的效率，保证软体的质量，而且在软体的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。
基本介绍
- 中文名 ：软体开发文档
- 提高 ：软体开发的效率
- 保证 ：软体的质量
- 分类 ：开发文档
简介
软体文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《资料库文档》、《功能函式文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。 用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。分类
开发文档
1. 《功能要求》 -- 来源于客户要求和市场调查，是软体开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软体的一个功能。有软体经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》 -- 根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言 -- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析 -- 项目要求、软体结构、功能列表、功能描述、注意事项等。 技术方案 -- 总体要求和指导思想、技术解决方案、软体开发平台、网路结构体系等。 项目管理 -- 描述公司的软体开发流程、工程实施服务、组织和人员分工、开发进度控制、软体质量保证、项目验收和人员培训、软体资料文档等。 技术支持 -- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和回响时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价 -- 软、硬体平台报价列表、软体开发费用、系统维护费用等。 项目进度 -- 整个项目的进度计画，包括签署契约、项目启动、需求分析、系统分析、程式开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 3. 《需求分析》 -- 包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ，列出本产品是什么，有什么特殊的概念，包括哪些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》 -- 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析 ( 产品的性能和实现方法 ) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》 -- 包括功能实现、模组组成、功能流程图、函式接口、数据字典、软体开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析 ( 产品的开发和实现方法 ) ，估计开发期间需要把什么问题说明白，程式设计师根据《系统分析》，开始在项目主管的带领下进行编码。 6. 《资料库文档》 -- 包括资料库名称、表名、栏位名、栏位类型、栏位说明、备注、栏位数值计算公式等。以《系统分析》为基础，进行详细的资料库设计。必要时可以用图表解说，特别是关系资料库。 7. 《功能函式文档》 -- 包括变数名、变数初值、功能，函式名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函式，以便以后程式设计师修改、接手和扩展。 8. 《界面文档》 -- 包括软体外观、界面素材、编辑工具、档案名称、选单、按钮和其它界面部件的要求，这里与软体完成后的运行界面是一致的。 9. 《编译手册》 -- 包括伺服器编译环境、作业系统、编译工具、 GNU 的 C++ 编译器版本信息、目录说明、程式生成、源程式档案列表、 Makefile 配置及其相关程式的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、作业系统、编译工具、源档案列表和制作安装程式的过程。 10. 《 QA 文档》 -- 包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、资料库结构、测试要求等，提供给软体测试人员使用。 11. 《项目总结》 -- 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。产品文档
1. 《产品简介》 -- 包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。 2. 《产品演示》 -- 包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模组、解决问题、合作伙伴、成功案例等。一般用 Power point 或者 VCD 录制软体实现。 3. 《疑问解答》 -- 列出用户关心的问题和处理方法。用于解答软体的操作功能和解决用户的疑难问题。 4. 《功能介绍》 -- 以《需求分析》为书写基础，包括软体介绍、软体结构、功能列表、功能描述和公司联系地址。 5. 《技术白皮书》 -- 以《技术分析》为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。 6. 《评测报告》 -- 第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。 7. 《安装手册》 -- 包括系统环境、运行平台、产品安装过程、初始环境设定、安装记录等。 8. 《使用手册》 -- 包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。 9. 《维护手册》 -- 包括产品简介、系统须知、初始环境设定、系统配置、数据管理和备份、技术问题解答和联系方式等。 10. 《用户报告》 -- 包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。 11. 《销售培训》 -- 包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。软体开发文档
第一、需求分析文档 用户需求分析文档是指在和客户进行沟通时，把用户所要求的信息记录下来，根据用户的要求进行需求分析，规划出我们要开发的软体所要实现哪些功能。 第二、概要设计文档 概要设计：顾名思义，就是对我们所要开发的软体进行一个整体的概括，把这个软体所包含的功能模组作一个设计，以后我们在开发的时候就有目标，有方向了。 第三、系统设计文档 系统设计，就是对概要的一个详细的实施，就是分析我们所要开发软体各大功能模组中所包含的小模组，把这些小模组都一一列举出来，然后再对软体开发人员进行有条理的进行开发任务的分配。 第四、详细设计文档 详细设计文档，主要是把我们每个小模组，小功能的业务逻辑处理用文字的方式表达出来，让程式设计师在编码的时候有一个依据和参照；同时，在进行详细文档设计的时候，有的软体公司也会根据不同的项目作出相应的《软体开发代码规范》性文档。以保障我们所做工作的统一性。 第五、软体测试文档 当我们参照软体详细设计文档编码完成后，接着就会根据我们所实现的功能，进行软体测试文档的编写；大多测试文档有两类，一类是软体单体测试文档，一类是软体结合测试文档；顾名思义，单体测试：就是对软体中每个小的方法，一个独立的方法进行测试的文档；结合测试：就是把多个功能模组组合到一起进行测试，主要是为了检测每个功能模组之前的互动性和功能的结合实现性。 第六、软体完成后的总结汇报型文档 不管所开发软体的规模大小，在一个软体开发结束后，我们都会把开发过中的问题和项目开发总结一起记录下来，以防以后在开发过程中再有类似问题出现，提高我们的开发效率。 根据软体开发公司的规模、标准和客户的需求不同，开发文档的种类和数量也不同，我在这里和大家讨论的软体开发相关文档都是最基础的；在软体行业有一句话：一个软体能否顺利的完成并且功能是否完善，重要是看这个软体有多少文档，软体开发文档是一个软体的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软体也不可能会好；开发文档的好坏可以直接影响到所开发出来软体的成功与否。
~
2023年新篇章,《Android开发进阶指北》完整版PDF开源!
答：每部分都为大家整理了详细的资料（PDF版本可点击卡片领取）内涵入门指南与实战详解，非常详尽全面，可陪伴各位从筑基到精进，步入中高级开发的殿堂。全套Android学习资料【PDF文档+视频】可点击下方卡片免费领取面试题大全+视频资料面试题大全《2022Android中高级面试必知必会》内含近年来各个大厂的面试真题 有...
软体公司详细资料大全
答：并以软体开发为主营业务的公司。软体开发公司的业务流程大致为：需求确认——概要设计——详细设计——编程——单元测试——集成测试——系统测试——维护。 补充1:需求确认由需求分析师完成，概要设计、详细设计由系统架构师和软体设计师共同完成，后期软体的开发和测试由程式设计师和软体测试人员完成。
Microsoft Office Excel(微软公司的办公软体之一)详细资料大全
答：微软目前将Office延伸作为一个开发平台,可以借由专用商店下载第三方软体搭配使用。 Office常是制作文档档案的标准,而且有一些其他产品不存在的特性,但是其他产品也有Office缺少的特性。自从Microsoft 2007 Office System开始,有一个和以前版本差异很大的用户界面,该界面被称为Ribbon界面,并沿用在Microsoft Office 2010、...
Microsoft Visual Studio 2008详细资料大全
答：Microsoft Visual Studio 2008是面向Windows Vista、Office 2007、Web 2.0的下一代开发工具，代号“Orcas”，是对Visual Studio 2005一次及时、全面的升级。VS2008引入了250多个新特性，整合了对象、关系型数据、XML的访问方式,语言更加简洁。使用Visual Studio 2008可以高效开发Windows套用。设计器中可以实时...
应用程式编程接口详细资料大全
答：API之主要目的是提供套用程式与开发人员以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。提供API所定义的功能的软体称作此API的实现。API是一种接口，故而是一种抽象。应用程式接口 （英语： A pplication P rogramming I nterface，简称： API ），又称为 套用编程接口 ，就是...
Director(套用软体)详细资料大全
答：软体名称 :Adobe Director 开发商 :Adobe 简介,优点,历史,功能,适用者,特点,界面方面易用,支持媒体类型,脚本工具,独有的三维空间,多种环境,可扩展性强,记忆体管理能力,套用技巧,设定movie以适应萤幕大小,带阴影效果的text,中文选单,filmloop播放问题,filmloop的控制,无人值守的情况,动态地改为Director内置图示,Lin...
文本文档详细资料大全
答：是最常见的一种档案格式，早在DOS时代套用就很多，主要存文本信息，即为文字信息，在微软在作业系统等于直接存，就是它了，多用的作业系统得使用记事本等程式保存，大多数软体可以查看如记事本，浏览器等等。 通俗：txt即文本档案，在桌面或资料夹右键即可建立。 TXT格式是一种文本文档，TXT（外语缩写...
中间体详细资料大全
答：对氨基酚是合成扑热息痛的重要中间体,增长迅速。我国对氨基酚年产量约为3.2万吨,预计到2005年,国内扑热息痛产量将达到5万吨以上,医药工业将消耗对氨基酚4.5万吨,再加上在其他领域的套用,2005年对氨基酚总需求量约为5万吨,市场缺口较大,开发利用前景广阔苯乙酸需求继续增大。 含氟吡啶类 截至2012年,我国已...
软体(按照特定顺序组织的计算机数据和指令的集合)详细资料大全
答：简单的说软体就是程式加文档的集合体。另也泛指社会结构中的管理系统、思想意识形态、思想政治觉悟、法律法规等等。 基本介绍 中文名 :软体 外文名 :Sofare 套用类别 :系统软体、套用软体等 开发语言 :Java、C/C++、Basic等 定义,特点,分类,套用类别,授权类别,相关概念,开发流程,软体工程师,法律保护,著作权归属,...
MARC(有限元分析软体)详细资料大全
答：此外,作为体成型分析的专用软体,MSC.Marc/AutoForge为满足特殊用户的二次开发需求,提供了友好的用户开发环境 MSC.Marc/Link MSC.Marc/Link是MARC高级有限元分析软体与SDRC I-DEAS、Pro/ENGINEER、CATIA等一系列著名CAD/CAE软体的集成界面。通过这种强强集成,使大量SDRC I-DEAS、Pro/ENGINEER、CATIA软体的忠实用户,...
