小白如何写需求文档

上学期在跟着网站里的学长学姐学了许多东西,假期我们需要自己做一套网站签到OA出来,昨天刚刚把需求文档定下,万事开头难,我把迈出的第一步记录下来,也给第一次写文档的小伙伴一些建议。

第 一次写,难免无从下手,在网上查找了大量的需求文档范例,网上也有模板,不过模板上东西很多,有些我还并不太了解,也不太适用于自己我们要做的OA. 既然是需求文档,那就应该根据项目实际情况去写文档,所以我们在写文档时注重的是我们需不需要,而非和模板是否符合。接下来,是我们写文档的步骤。

1、定框架

首先要把整篇文档需要的内容,大标题,子标题记录下来,即做成目录的形式。如图,这是我跟模板内容选出来的符合我的需要的,加以整理。

2.书写文字部分

在定好框架之后,我开始写引言、和环境需求、非功能需求的部分,这些相对好写,耗费时间也不长,可网上搜索资料,可和搭档讨论,这里也很重要,要考虑多方面的问题。

3.定功能、写功能需求

开 始写功能需求之前,首先要大家要把目标功能定下来,每个功能的细节也要讨论到,讨论过程中要做记录手稿,全靠脑袋是记不住的。这一步很重要,千万不可以想 到一个功能添加一个,因为各功能之间会有关联,临时起意的功能很容易导致各功能之间存在矛盾或重复,最后写出来也会让人看不懂。其次注意功能要切合实际, 不能想怎样就怎样,要考虑到后期实现的可能性,以及用户体验感,这个功能是否必要或多余。

功能定好之后,就可以愉快的总结出来,制成表格 啦。每个功能要说明名称、编号、操作流程(即如何使用此功能)、和备注。若功能分类较多,要注意命名时的简洁易懂,分类清晰,会给后面代码的编写带来很大 的方便。操作流程也是尽可能详细,记录下对每个功能如何实现的详细想法,同样是为编写代码省去麻烦。

4.数据库建表、画ER图

这步需要时间较长。我们是先画出ER图,再根据图建表,会快很多。

画图之前要搞清楚需要哪些数据,又有哪些表,以及表与表之间的关系。画图时,以矩形作为表名,椭圆形为表的属性值,菱形代表两表之间的关系。

有图之后,建表就可以根据ER图来做,两者要保持一致。

表的内容包括,列名、数值类型、长度、是否为空、主外键设置等

5.补充修改细节

在上面四步都做好之后,整篇文档基本成型了。最后我们又多次浏览文档,尤其是功能,检查实现功能的逻辑是否合理。一定要大家一起讨论,自己一个人是看不出问题的。如果有学长学姐,最好请教一下他们,他们会给出很棒很好的建议,并且指出错误,可以进一步完善文档。

以上就是我们在写需求文档时的步骤。如果有不当错误之处,希望您能给小白指明,这样小白才能改正错误、获得进步。谢谢您的阅览!

时间: 2024-10-10 20:07:56

小白如何写需求文档的相关文章

产品经理应该先写需求文档还是先画原型?

江洋@知乎上的回答: 先做模型,再画原型,最后PRD 模型:对产品形态结构的梳理,包括功能模块,逻辑关系,信息架构,业务流程等,可以用脑 图,use case图,业务流程图来表示,根据不同产品,产出物的侧重点不同.但模型很必要,是可以帮助产品经理将一个想法,或是脑子中的模型梳理清楚,在做这些工作的同时,可以及时发现自己没有想清楚的细节,这些是指导后面产品设计师(或产品经理)进行原型设计的.同时,描述模型的产出物可以做为传递,帮助别人理 解你的产品形态. 软件:MindManager,Visio

产品经理应该先写需求文档还是先画原型图

先做模型,再画原型,最后PRD 模型:对产品形态结构的梳理,包括功能模块,逻辑关系,信息架构,业务流程等,可以用脑 图,use case图,业务流程图来表示,根据不同产品,产出物的侧重点不同.但模型很必要,是可以帮助产品经理将一个想法,或是脑子中的模型梳理清楚,在做这些工 作的同时,可以及时发现自己没有想清楚的细节,这些是指导后面产品设计师(或产品经理)进行原型设计的.同时,描述模型的产出物可以做为传递,帮助别人理 解你的产品形态. 软件:MindManager,Visio 原型:即画出产品la

婧城石化 我得第一次写需求文档 希望大家点评

婧城石化 1. 背景: 企业背景 山东省淄博市周村区催化剂的婧城石化老板想做一个打卡系统,该公司年产值在1000万左右主要从事化工塑料方面在全国范围内销售,该公司员工有50-60员. 实现功能 公司想做一个打卡系统,需要两种方式的签到方式,一种是出差人员要手机app 一种是公司里面指纹打卡机.可以显示所有员工签到情况,需要一个月时间完成.主要手机app.客户想要实时了解员工信息(网页.APP都可以). 2.项目业务流程 1.注册功能 注册登陆账号密码 可以用员工编号手机号注册,员工自己注册.注册

需求文档中容易出的错误

需求文档中容易出现的主要问题: 1.需求缺失 2. 需求不明确   本周开会的时候,PMs分享了三个案例,其中有两个谈到需求不明的情况.第三个项目是Agile实施项目,不存在需求不明的情况.其原因,我猜测由于甲方主导的Agile的项目,因此,需求方面主要掌握在甲方,甲方管理更好一些. 总的来说,需求不明几乎是所有项目的通病.下面的内容有点飘,叔思维一直是这样,将就了. 需求的不明晰,要区分是需求范围不清晰还是需求内容不清晰.因为这两者有本质的不同. 那么何为范围不清晰呢?我举一个典型的例子,有公

为什么必须要有需求文档这种东西?

当一个东西你已经习以为常了你不会感觉它的意义,但是有一天突然间这个东西没了,那你就会非常难受. 需求文档就是这样的一种东西,大公司或中型公司肯定会有这种东西,但小公司就很少有.如果没有写需求文档会导致这个需求只有公司的某个人知道,而其他人如果想要参与到这项工作中就需要问他,你问一句,他问一句,别人还怎么工作呢?需求文档是为了降低沟通成本,节约时间,不影响别人工作而发明的,只要写好了需求文档,谁都可以看,谁也别问谁,谁也别影响谁. 需求文档是属于流程规范化的一个部分,这是专业性的表现,我们弄这个弄

机房收费系统--需求文档

软件设计都是从需求开始的,需求文档的编写往往就要求调研人员到市场上进行调研,回来后跟开发人员协商讨论而确定的.需求文档旨在详细描述系统使用人员对系统了解的细节,让编程人员认识到代码实现的难易程度,是系统开发人员与用户沟通的桥梁. [描述哪些内容] 1. 为什么要写需求文档,即编写目的-------介绍编写这篇文档的好处,让大家认识到这篇文章的重要性. 2. 对系统的简要介绍,即编写背景,包含项目名称.提出者等有关项目的信息-----直入主题,让读者明确文章主题. 3. 项目的目标.用户特点和约束

app开发需求文档怎么写

我们在开发app前都会做需求分析,这个app开发需求文档怎么写呢?一般可以从这几点入手:确定APP方案的目标,APP方案的受众分析,APP开发方案功能设计,APP的操作系统说明方案,APP是是否是原生APP,APP方案的视觉设计,APP开发方案中的其他细节.以下是一个app开发需求文档模板,里面写清了app开发需求说明,可以参考 1.引言 1.1目的: · 阐明开发本app的目的:  1.2 项目背景 · 标识待开发app产品的名称.代码:  · 列出本项目的任务提出者.项目负责人.系统分析员.

【产品】好的产品需求文档(PRD)怎么写?

PRD(Product Requirement Document,产品需求文档),顾名思义是阐述产品需求的一种文档,其核心是将需求描述清楚. 通过PRD可以看出一个产品经理对产品理解的逻辑思维,产品经理在相关领域的认知和专业的深度以及对产品全局的认识.如何才能写出好的PRD,让产品研发团队成员,开发.测试.运营同学了解产品需求,让其他人能从该文档中看到产品的价值和意义,估计很多人都思考过,如何让PRD不被其他人挑战,如何获得他们的认可估计是产品经理经常考虑的问题.也有人可能认为PRD只要中心思想

如何写好产品需求文档?

常常有人问我怎么写prd,在深受市面上流行的功能需求模板“残害”之后,我现在一般不会向别人推荐任何所谓的“模板”. 需求文档是产品需求的表达方式,而其中需要描述什么内容取决于产品经理想要描述什么,即产品经理的需求.如果产品经理的需求是明确的,而且产品经理脑中有物,那么需求文档自然而然就出来了.最可怕的是产品经理自己都不知道自己要描述的是什么内容,这个时候即使有模板,写出来的东西也是一团糟. 互联网产品以用户为中心,所以prd也应该站在用户的角度来描述,如果不知道自己要写什么,在写文档之前产品经理