撰写软件开发过程文档（常用的软件开发过程文档）
本篇文章给大家谈谈撰写软件开发过程文档，以及常用的软件开发过程文档对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。
本文目录一览：
我该怎么写详细开发文档？
以下nbsp;是我们单位的nbsp;项目开发计划书nbsp;希望对你有帮助编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、nbsp;所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开nbsp;发工作。编制内容要求如下：nbsp;nbsp;nbsp;nbsp;1nbsp;引言nbsp;nbsp;nbsp;1．1编写目的nbsp;nbsp;nbsp;nbsp;说明编写这份项目开发计划的目的，并指出预期的读者。nbsp;nbsp;nbsp;1．2背景nbsp;nbsp;nbsp;说明：nbsp;nbsp;nbsp;a．待开发的软件系统的名称；nbsp;nbsp;nbsp;b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；nbsp;nbsp;nbsp;C．该软件系统同其他系统或其他机构的基本的相互来往关系。nbsp;nbsp;nbsp;1．3定义nbsp;nbsp;nbsp;nbsp;列出本文件中用到的专门术语的定义和外文首字母组词的原词组。nbsp;nbsp;nbsp;1．4参考资料nbsp;nbsp;nbsp;列出用得着的参考资料，如：nbsp;nbsp;nbsp;a．本项目的经核准的计划任务书或合同、上级机关的批文；nbsp;nbsp;nbsp;b．属于本项目的其他已发表的文件；nbsp;nbsp;nbsp;C．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。nbsp;列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。nbsp;nbsp;nbsp;2nbsp;项目概述nbsp;nbsp;nbsp;nbsp;2．1nbsp;工作内容nbsp;nbsp;nbsp;简要地说明在本项目的开发中须进行的各项主要工作。nbsp;nbsp;nbsp;2．2主要参加人员nbsp;nbsp;nbsp;扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。nbsp;nbsp;nbsp;nbsp;2．3产品nbsp;nbsp;nbsp;2．3．1程序nbsp;nbsp;nbsp;列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。nbsp;nbsp;nbsp;nbsp;2．3．2文件nbsp;nbsp;nbsp;列出需移交给用户的每种文件的名称及内容要点。nbsp;nbsp;nbsp;nbsp;2．3．3服务nbsp;nbsp;nbsp;列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持nbsp;的级别和服务的期限。nbsp;nbsp;nbsp;2．3．4非移交的产品nbsp;nbsp;nbsp;nbsp;说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。nbsp;nbsp;nbsp;2．4验收标准nbsp;nbsp;nbsp;nbsp;对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。nbsp;nbsp;nbsp;nbsp;2．5完成项目的员迟用限nbsp;nbsp;nbsp;nbsp;2．6本计划的批准者和批准日期nbsp;nbsp;nbsp;nbsp;3nbsp;实施计划nbsp;nbsp;nbsp;nbsp;3．1工作任务的分门与人员分工nbsp;nbsp;软件开发网nbsp;;nbsp;对于项目开发中需完成的各项工作，从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作，用户培训工作，软件安装工作等，按层次进行分解，指明每项任务的负责人和参加人员。nbsp;nbsp;nbsp;3．2nbsp;接口人员nbsp;nbsp;nbsp;说明负责接口工作的人员及他们的职责，包括：nbsp;nbsp;nbsp;anbsp;．负责本项目同用户的接口人员；nbsp;nbsp;nbsp;b．负责本项目同本单位各管理机构，如合同计划管理部门、财务部门、质量管理部门等的接口人员；nbsp;nbsp;nbsp;nbsp;c．负责本项目同各分合同负责单位的接口人员等。nbsp;nbsp;nbsp;nbsp;3．3进度nbsp;nbsp;nbsp;nbsp;对于需求分析、设计、编码实现、测试、移交、培训和安装等工作，给出每项工作任务的预。定开始日期、完成日期及所需资源，规定各项工作任务完成的先后顺序以及表征每项工作任务完成的标志性事件（即所谓“里程碑“）。nbsp;nbsp;nbsp;nbsp;3．4预算nbsp;nbsp;nbsp;nbsp;逐项列出本开发项目所需要的劳务（包括人员的数量和时间）以及经费的预算（包括办公费、差旅费、机时费、资料费、通讯设备和专用设备的租金等）和来源。nbsp;nbsp;nbsp;3．5关键问题nbsp;nbsp;nbsp;逐项列出能够影响整个项目成败的关键问题、技术难点和风险，指出这些问题对项目的影响。nbsp;[Page]nbsp;nbsp;nbsp;4nbsp;支持条件nbsp;nbsp;nbsp;说明为支持本项目的开发所需要的各种条件和设施。nbsp;nbsp;nbsp;4．1计算机系统支持nbsp;nbsp;nbsp;逐项列出开发中和运行时所需的计算机系统支持，包括计算机、外围设备、通讯设备、模拟器、编译nbsp;（或nbsp;汇编）程序、操作系统、数据管理程序包、数据存储能力和测试支持能力等，逐项给出有关到货日期、nbsp;使用时间的要求。nbsp;nbsp;nbsp;4．2需由用户承担的工作nbsp;nbsp;nbsp;逐项列出需要用户承担的工作和完成期限。包括需由用户提供的条件及提供时间。nbsp;nbsp;nbsp;4．3由外单位提供的条件nbsp;nbsp;nbsp;nbsp;逐项列出需要外单位分合同承包者承担的工作和完成的时间，包括需要由外单位提供的条件和提nbsp;供的时间。nbsp;nbsp;nbsp;nbsp;5nbsp;专题计划要点nbsp;nbsp;nbsp;说明本项目开发中需制
你会写软件开发文档吗
关于写软件开发文档的人员肯定、肯定是有的。但是问题是软件开发文档在整个软件开发过程中是软件开发的必不可少的重要一部分，因此不会有人免费为别人编写软件各类文档（包括详细设计、软件测试等文档）。即使真的需要做这个工作，那也需要双方坐下来一起签正式的软件开发合同才行。
软件开发项目中，过程管理文档都包括什么？
在软件项目开发过程中，应该按软件开发要求撰写十三类文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性！\x0d\x0a需求阶段\x0d\x0a1、可行性分析报告\x0d\x0a说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。\x0d\x0a2、项目开发计划\x0d\x0a为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。\x0d\x0a3、软件需求说明书（软件规格说明书）\x0d\x0a对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。\x0d\x0a设计阶段\x0d\x0a4、概要设计说明书\x0d\x0a该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。\x0d\x0a5、详细设计说明书\x0d\x0a着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。\x0d\x0a开发阶段\x0d\x0a6、开发进度月报\x0d\x0a该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。\x0d\x0a测试阶段\x0d\x0a7、测试计划\x0d\x0a为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。\x0d\x0a8、测试分析报告\x0d\x0a测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。\x0d\x0a收尾阶段\x0d\x0a9、用户操作手册\x0d\x0a本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。\x0d\x0a10、项目开发总结报告\x0d\x0a软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。\x0d\x0a11、软件维护手册\x0d\x0a主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。\x0d\x0a维护阶段\x0d\x0a12、软件问题报告\x0d\x0a指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软\x0d\x0a件修改提供准备文档。\x0d\x0a13、软件修改报告\x0d\x0a软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。
软件开发需要编写哪些文档？
这个问题没有一定的，因为这里有多种因素
如，开发阶段、文档化要求程度等，若是通过CMM评估的，文档就较多
一般的是按项目开发过程来分，基本的有
可行性研究报告（若是一个新项目且未确定的或应客户要求时需要，实际上大部份公司很少有这文档)
用户需求说明书(用户+开发人员共同确认)
软件需求规格说明书
设计说明书(体系结构、详细设计)
测试用例
用户手册
实现代码
这些文档中，包括一定的分析与设计图形，如用例图、数据库结构、ER图等
当然项目计划、测试计划也应算在内
其它的(如CMM要求的)
风险、估算方面的，质量保证方面的、配置管理方面、定义的模板、度量数据库等
具体需要多少文档就是要看项目实际
这方面的东西，可参考一些软件工程类的书
怎么写项目开发的文档？
软件开发中文档的编写是一个不可缺少的环节，常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点，注重文档还是关心代码。
我这里写一个《用户信息模块的概要设计文档》，只列举主要内容了
1.功能描述：用于完成系统用户信息的新增、删除、修改、查询；
2.功能用例：一个主用例用户信息，附加新增、删除、修改、查询4个子用例，操作人员为管理员，图形就不画了，很简单的；
3.业务流程：查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示，反之保存成功提示。
4.约束限制：超级管理员可操作所有（包含删除，我这里考虑仅是逻辑删除、非物理删除）的用户信息；系统管理员可操作除系统管理员、超级管理员外的全部用户信息；单位管理员可操作本单位用户信息；用户帐号信息系统内全局唯一；
5.系统性能：要求同时支持500个并发操作；页面操作响应时间小于1s；页面大小小于1kb；
当前用户所属员工信息不存在时，可直接进行员工信息的添加，并完成用户信息的同步保存，确保事务的完整性；
6.运行环境：依赖系统整体运行环境为准（存在特殊需要注明）；
7.操作实体：用户信息、员工信息、系统日志等。
8.异常处理：如果系统框架中已经提供相关说明，这里仅需要注明符合系统架构异常处理方式即可。
9.外部接口：输入—用户ID，输出—用户信息；
10.其他说明：用户帐号必须定义为字母开头，数字与字母组合，并保证全局唯一；用户密码采用md5算法加密，系统架构已提供相关接口。
11.注意事项：用户帐号不能为空，不能存在空格，不能超过6位；超级用户信息仅在系统初始化中完成其信息写入操作，其他用户无权对其进行修改。
项目组中也不是所有人都必须参与文档的编写，通常业务需求人员、设计人员、架构师、项目经理、小组长占大多数，而且这些人中很多也不是专注于写代码的角色。
软件开发文档应该如何写？
如果我们知道软件文档的价值，那么为什么不经常使用它呢？对于新手，大多数软件文档都存在很多下面提到的这些问题：
· 糟糕的语法和/或拼写错误的词语
· 不完整
· 过期或不准确
· 篇幅太长
· 首字母缩写没有解释或术语不专业
· 难于找到信息或在文档中定位 软件开发网
存在这些问题的主要原因是软件文档通常没有被给予足够的重视。项目预算被迫将主要活动花在了开发工作上，在那里管理层很容易看到他们的收益。值得投入成本的文档工作通常都是主观的，而且通常被刻画为需要避免的成本，因为它们被认为不能产生投资回报（ROI）。很多项目经理将客户所需要的最少文档看作是“镀金”。
软件开发网
软件文档的另外一个麻烦来源是文档的作者。很多应用程序开发经理觉得软件文档是开发工作的一个标准部分，因此，要求他们的开发人员在编码时也编写软件文档。
虽然这在理论上是说得过去的，但是不应该将开发人员看成文档作者。很简单，技术人员只被培训如何开发，而没有被培训如何写文档。为了解决这一问题，很多应用程序开发经理尝试通过聘请一些技术性写手或商业分析人员来提高他们的软件文档的质量。这就导致出现了一个相反的问题：技术写手和商业分析人员通常只有有限的技术技能。
解决方案依赖于文档，文档应该迎合其潜在读者的口味。这方面的通用规则是要求使用一个协同工作方法来编写文档，这种方法允许开发人员和写手发挥他们的长处。例如，如果潜在的读者是系统设计人员，那么开发人员应该提供详细的输入，但是允许技术写手去组织和编辑内容以使文档符合语法。
不管潜在的读者还是被选中的读者，软件文档的质量与其可使用性相关，以下六个属性可以用来测量软件文档的可使用性：
· 适用性：文档提供了相关的信息吗？
· 合时性：文档所提供的是当时的信息吗？
· 正确性：文档所提供的信息正确吗？
· 完整性：文档是不是足够详细？
· 可用性：文档随手可用吗？
· 可使用性：能够快速直观地找
希望能助你一臂之力
关于撰写软件开发过程文档和常用的软件开发过程文档的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。
