软件开发需要编写哪些文档？

1. 软件开发需要编写哪些文档？

这个问题没有一定的，因为这里有多种因素   
  如，开发阶段、文档化要求程度等，若是通过CMM评估的，文档就较多   
    
  一般的是按项目开发过程来分，基本的有     
  可行性研究报告（若是一个新项目且未确定的或应客户要求时需要，实际上大部份公司很少有这文档)   
  用户需求说明书(用户+开发人员共同确认)   
  软件需求规格说明书   
  设计说明书(体系结构、详细设计)   
  测试用例   
  用户手册   
  实现代码   
    
  这些文档中，包括一定的分析与设计图形，如用例图、数据库结构、ER图等   
  当然项目计划、测试计划也应算在内   
    
  其它的(如CMM要求的)   
  风险、估算方面的，质量保证方面的、配置管理方面、定义的模板、度量数据库等   
  具体需要多少文档就是要看项目实际   
    
  这方面的东西，可参考一些软件工程类的书

2. 软件开发文档干什么的？

　　在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。

　　1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。

　　2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。

　　3)作为开发人员在一定阶段的工作成果和结束标志。

　　4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。

　　5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。

　　6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。

　　文档在各类人员、计算机之间的多种桥梁作用中看出：

　　既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发

　　规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。

　　PS：软件开发文档包括：

　　操作手册

　　维护修改建议

　　软件需求（规格）说明书

　　开发文档 软件需求（规格）说明书

　　数据要求说明书

　　概要设计说明书

　　详细设计说明书

　　可行性研究报告

　　项目开发计划

　　管理文档 项目开发计划

　　测试计划

　　测试报告

　　开发进度月报

　　开发总结报告

3. 软件文档编写在软件开发过程中的应用？

五．性能需求
1．数据精确度
2．时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）
3．适应性（在操作方式 运行环境 与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。）
六．运行需求
1．用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）
2．硬件接口
3．软件接口
4．故障处理
七．其他需求（如可使用性、安全保密、可维护性、可移植性等。）
概要设计说明
一．引言
1．编写目的（阐明编写概要设计说明书的目的，指明读者对象。）
2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）
3．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目经核准的计划任务书，合同或上机机关的批文；（2）项目开发计划；（3）需求规格说明书；（4）测试计划（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采用的标准或规范。）
二．任务概述
1．目标
2．运行环境
3．需求概述
4．条件与限制
三．总体设计
1．处理流程
2．总体结构和模块外部设计
3．功能分配（表明各项功能与程序结构的关系。）
四．接口设计
1．外部接口（包括用户界面 软件接口与硬件接口。）
2．内部接口（模块之间的接口。）
五．数据结构设计
1．逻辑结构设计
2．物理结构设计
3．数据结构与程序的关系
六．运行设计
1．运行模块的组合
2．运行控制
3．运行时间
七．出错处理设计
1．出错输出信息
2．处理对策（如设置后备、性能降级、恢复及再启动等。）
八．安全保密设计
九．维护设计（说明为方便维护工作的设施,如维护模块等。）
详细设计说明书
一．引言
1．编写目的（阐明编写详细设计说明书的目的,指明读者对象。）
2．项目背景（应包括项目的来源和主管部门等。）
3．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格说明书；（3）概要设计说明书；（4）测试计划(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软件开发标准或规范。）
二．总体设计
1．需求概述
2．软件结构（如给出软件系统的结果图。）
三．程序描述（逐个模块给出以下的说明:：）
1．功能
2．性能
3．输入项目
4．输出项目
5．算法（模块所选用的算法。）
6．程序逻辑（详细描述模块实现的算法，可采用:：（1）标准流程图；（2）PDL语言；（3）N-S图；（4）PAD；（5）判定表等描述算法的图表。）
7．接口
8．存储分配
9．限制条件
10.测试要点（给出测试模块的主要测试要求。）
用户操作手册
一．引言
1．编写目的（阐明编写手册的目的，指明读者对象。）
2．项目背景（说明项目的来源、委托单位、开发单位及主管部门。）
3．定义（列出手册中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；（6）测试计划；（7）手册中引用的其他资料、采用的软件工程标准或软件工程规范。
三．运行环境
1．硬件（列出软件系统运行时所需的硬件最小配置，如：（1）计算机型号、主存容量；（2）外存储器、媒体、记录格式、设备型号及数量；（3）输入、输出设备；（4）数据传输设备及数据转换设备的型号及数量。）
2．支持软件（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称及版本号；（3）数据库管理系统的名称及版本号；（4）其他必要的支持软件。）
四．使用说明
1．安装和初始化（给出程序的存储形式、操作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件工具等。）
2．输入（给出输入数据或参数的要求。）
（1）数据背景（说明数据来源、存储媒体、出现频度、限制和质量管理等。）
（2）数据格式（如：（1）长度（2）格式基准（3）标号（4）顺序（5）分隔符（6）词汇表（7）省略和重复（8）控制。）
（3）输入举例
3．输出（给出每项输出数据的说明。）
（1）数据背景（说明输出数据的去向、使用频度、存放媒体及质量管理等。）
（2）数据格式（详细阐明每一输出数据的格式,如:首部 主体和尾部的具体形式。）
（3）举例
3．出错和恢复（给出：（1）出错信息及其含义（2）用户应采取的措施，如修改、恢复、再启动。）
4．求助查询（说明如何操作。）
五．运行说明
1．运行表 [列出每种可能的运行情况,说明其运行目的.]
2．运行步骤 [按顺序说明每种运行的步骤,应包括:]
（1）运行控制
（2）操作信息（（1）运行目的（2）操作要求（3）启动方法（4）预计运行时间（5）操作命令格式及说明（6）其他事项。）
（3）输入/输出文件（给出建立和更新文件的有关信息，如：（1）文件的名称及编号（2）记录媒体（3）存留的目录（4）文件的支配[说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等。）
（4）启动或恢复过程
六．非常规过程（提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。）
七．操作命令一览表
（按字母顺序逐个列出全部操作命令的格式 功能及参数说明。）
八．程序文件（或命令文件）和数据文件一览表（按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

4. 软件开发文档包括哪些

软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。
软件文档可以分为开发文档和产品文档两大类。
开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《 QA 文档》、《项目总结》等。
产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》。
用户文档《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

5. 如何写软件设计文档

按照以下格式填就好了，不过是我自己写的，有不好的地方大家互相学习修改一下~

详细设计文档规范
1.0概述
这部分提供对整个设计文档的概述。描述了所有数据，结构，接口和软件构件级别的设计。
1.1 目标和对象
描述软件对象的所有目标。
1.2 陈述范围
软件描述。主要输入，过程功能，输出的描述，不考虑详细细节。
1.3 软件内容
软件被置于商业或者产品线中，讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。
1.4 主要系统参数
任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。
2.0 数据设计
描述所有数据结构包括内部变量，全局变量和临时数据结构。
2.1 内部软件数据结构
描述软件内部的构件之间的数据传输的结构。
2.2 全局数据结构
描述主要部分的数据结构。
2.3 临时数据结构
为临时应用而生成的文件的描述。
2.4 数据库描述
作为应用程序的一部分，描述数据库结构。
3.0 结构化和构件级别设计
描述程序结构。
3.1 程序结构
详细描述应用程序所选定的程序结构。
3.1.1 结构图
图形化描述结构。
3.1.2 选择性
讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。
3.2 构件描述
详细描述结构中的每个软件构件。
3.2.1 构件过程叙述(PSPEC)
描述构件的过程。
3.2.2 构件接口描述
详细描述构件的输入和输出。
3.2.3 构件执行细节
每个构件的详细演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 规范/限制
]3.2.3.4 本地数据结构
3.2.3.5 在3.2.3.6设计中包含的执行结果
3.3 软件接口描述
软件对外界的接口描述
3.3.1机器对外接口
与其他机器或者设备的接口描述。
3.3.2系统对外接口
对其它系统、产品和网络的接口描述。
3.3.3与人的接口
概述软件与任何人的界面。
4.0 用户界面设计
描述软件的用户界面设计。
4.1 描述用户界面
详细描述用户界面，包括屏幕显示图标、图片或者类型。
4.1.1 屏幕图片
从用户角度描述界面。
4.1.2 对象和操作
所有屏幕对象和操作的定义。
4.2 界面设计规范
用户界面的设计和实现的规范和标准。
4.3 可见构件
实现的GUI可见构件说明。
4.4 UIDS描述
用户界面开发系统描述。
5.0约束、限制和系统参数
会影响软件的规格说明、设计和实现的特殊事件。
6.0测试标准
测试策略和预备测试用例描述。
6.1 测试的类别
规定实施测试的类别，包括尽量详细的描述。这里是针对黑盒测试现象的描述。
6.2期待软件反馈
测试期待的结果描述。
6.3执行界线
特殊执行需要的说明。
6.4 重要构件确认
决定性构件或者需要特殊注意的构件的测试确认。
7.0附录
设计说明的补充信息。
7.1系统可跟踪矩阵
一个定期回归系统规格跟踪软件需求的矩阵。
7.2 产品战略
如果规格说明书是为一个产品设计的，描述相关的产品战略。
7.3 使用分析算法
描述所有分析活动所使用到的分析算法。
7.4 补充信息 (如果有需要特别说明的)

6. 如何写软件设计文档？

1 引言
1.1 编写目的
    说明编写这份详细设计说明书的目的，指出预期的读者范围。
1.2 背景
说明：
a． 待开发的软件系统的名称；
b． 列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。
1.3 定义
    列出本文件中用到的专门术语的定义和缩写词的原词组。
1.4 参考资料
列出要用到的参考资料，如：
a． 本项目的经核准的计划任务书或合同、上级机关的批文；
b． 属于本项目的其他已发表的文件；
c． 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

7. 软件开发文档的介绍

软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。

8. 软件开发文档应包括哪些内容？

开发文档
1. 《功能要求》 -- 来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。
2. 《投标方案》 -- 根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言 -- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析 -- 项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案 -- 总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理 -- 描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持 -- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价 -- 软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度 -- 整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
3. 《需求分析》 -- 包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析 ( 包括客户提出的要求和根据开发经验建议的功能 ) ，列出本产品是什么，有什么特殊的概念，包括哪些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
4. 《技术分析》 -- 包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析 ( 产品的性能和实现方法 ) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。
5. 《系统分析》 -- 包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析 ( 产品的开发和实现方法 ) ，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。
6. 《数据库文档》 -- 包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。
7. 《功能函数文档》 -- 包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。
8. 《界面文档》 -- 包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。
9. 《编译手册》 -- 包括服务器编译环境、操作系统、编译工具、 GNU 的 C++ 编译器版本信息、目录说明、程序生成、源程序文件列表、 Makefile 配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。
10. 《 QA 文档》 -- 包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。
11. 《项目总结》 -- 包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。