系统开发需求文档模板(附完整需求文档的内容)

系统开发需求文档模板(附完整需求文档的内容)

软件开发前,需求文档必不可少。对于选择外包团队开发软件的企业来说,一般会通过沟通,产品经理全权负责编写需求文档,而从企业角度出发,了解需求文档的板块内容,能够有效掌握软件开发的进程,何乐而不为呢?下面科太保就与大家分享开发文档所包含的内容。

一、需求文档的作用

之前提到过『结构流程图』是产品的骨架,非常重要,但团队中很多成员对其实无感的,因为产品本身就是一个故事,仅仅有故事的构思是远远不够的,要想把故事讲好,还需要赋予故事更多的细节与血肉,这就是需求文档的作用。

需求文档的读者可以明确划分为:开发、设计与测试。不同读者想从中获取的信息也有所不同,开发想了解产品的功能逻辑;设计想确定交互与布局,而测试则想知道具体的测试点。

所以需要针对以上三类人群,需求文档要进行三种不同的描述,分别为:开发注意事项、设计注意事项、测试注意事项。而实际的操作中,测试注意事项多数会被开发与设计注意事项所涵盖,所以测试注意事项多数可以不写。

二、开发文档包含什么内容?

1.功能要求

2.投标方案

根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写投标方案,方案书一般包括前言、需求分析、技术方案、项目管理、技术支持、系统报价、项目进度等。

3.需求分析

包括产品概述、主要概念、操作流程、功能列表、注意事项、系统环境等。以功能要求为基础,进行详细的功能分析,列出本产品是什么,有什么特殊的概念,包括那些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

4.技术分析

包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。以需求分析为基础,进行详细的技术分析(产品的性能和实现方法),列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。

5.系统分析

包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础,进行详细的系统分析(产品的开发和实现方法),程序员根据系统分析,开始在项目主管的带领下进行编码工作。

6.数据库文档

包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础,进行详细的数据库设计,必要时可以用图表解说,特别是关系数据库。

7.功能函数文档

包括变量名、变量初植、功能、函数名、参数、如何调用、备注、注意事项等。以系统分析为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。

8.界面文档

发表评论

登录后才能评论