项目开发文档编写规范

前言

在开发项目的过程中,我深刻的意识到,文档存在的意义并不是无用的报告,简洁明了的文档不光能记录你当下所做的,还能在繁重的工作中分神思考下一步该做什么时为你节约精力,并且在项目周期内,使整个项目保持一致性。所以,软件开发文档的编写是很有必要的。我参考网上的资料,结合自己项目开发时的心得,分享一些经验。

文档类型

在项目开发过程中,应该按要求编写好十三种文档,文档编写要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。同时依照项目人员的角色划分,完成不同类型的文档。以下排序并未严格按照时间排序。

类型说明

可行性分析报告(产品人员)

可行性研究报告的编写目的是:说明该软件开发项目的实现在技术、经济和社会条件方面的可行性;评述为了合理达到开发目标而可能选择的各种方案;实施方案的利弊;说明并论证所选定的方案。

项目开发计划(产品人员)

软件项目开发计划即为软件项目实施方案制定出的具体计划。项目开发计划应提前给管理部门,并作为开发阶段评审的基础。编写项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需的软硬条件等问题做出的安排记载下来,以便根据本计划开展和检查项目的开发工作。

软件需求说明书(产品人员)

软件需求说明书也称为软件规格说明。该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。软件需求说明书的编写目的就是为了使用户和软件开发者双方对该软件的初需求有一个共同的理解,并使之成为整个开发工作的基础。

概要设计说明书 (开发人员)

概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统。编写的目的是说明对程序系统的设计考虑,包括程序系统的基本处理。流程、程序系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。

详细设计规格说明书(开发人员)

详细设计说明书又可称程序设计说明书。编写目的是说明一个软件系统各个层次中的每一个程序(每人模块或子程序)的设计考虑。如果项目比较简单,层次较少,本文件可以不单独编写,有关内容合并入概要设计说明书。

用户操作手册(产品人员)

用户操作手册的编写是要使用非专门术语的语言,充分地描述该软件系统所具有的功能及基本的使用方法,提供该软件每一个运行的具体过程和有关知识,包括操作方法的细节。使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下,如何使用它。

测试计划(测试人员)

测试计划是软件项目实施计划中的一项重要的内容,应当在软件开发初期、即需求分析阶段制订。测试计划应当定义被测试对象和测试目标,确定测试阶段和测试周期的划分;制订测试人员、软硬件资源和测试进度等方面的计划,规定软件测试方法,测试标准以及支持环境和测试工具。针对子系统在特定的测试阶段所要进行的测试工作制订详细计划,它详细说明规定了测试小组的各项测试任务,测试策略、任务分配和进度安排等。

测试分析报告(测试人员)

测试工作完成以后,应当提交测试计划情况说明书,对测试结果加以分析,并提出测试的结论性意见。

开发进度月报(开发人员)

开发进度月报的编写目的是及时向有关部门汇报项目开发的进度和情况,以便及时发现和处理开发过程中出现的问题,一般,开发进度月报是以项目组单位每月编写的。如果被开发的软件系统规模比较大,整个工程项目被划分给若干个分项目驵承担,开发进度月报将以分项目为单位每月编写。

项目开发总结报告(产品人员)

软件项目开发完成之后,应当与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力。此外,还需对开发工作做出评价,总结经验和教训。项目开发总结报告的编写是为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价。

软件维护手册(开发人员)

主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护 过程的说明,便于软件的维护。

软件问题报告(测试人员)

指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。

软件修改报告(开发人员)

软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。

总结

根据项目的规模大小,以及人员构成,对所需要的文档进行编写,将大大提高项目开发的效率及规范程度。

参考资料

  1. 软件开发相关文档刘米雪
  2. 软件开发文档总集Recode_的专栏
  3. 软件开发文档编写规范zhanghui962623727的博客
©️2020 CSDN 皮肤主题: 编程工作室 设计师:CSDN官方博客 返回首页