写了一年的需求文档,我想告诉你……
ccwgpt 2024-11-20 13:09 45 浏览 0 评论
本文作者写了大概一年的需求文档,对需求文档也有了不同于一开始的认识,也积累了一些经验,在此分享给大家。
到目前为止,大概写了一年的需求文档。
整个过程从零开始,通过自己的探索(反复练习与参考资料),也算能产出一份比较满意的需求文档,接下来需求文档的作用说起。
需求文档的作用
1. 帮助产品经理梳理功能逻辑,构建产品的框架
很多人会认为需求文档是给开发同学与设计同学看的,目的是让他们更好地理解需求。但经过一年的实践,越发觉得产品同学才是需求文档最大的受益者。
写需求文档过程,也是构思产品的过程。需求文档中包含『产品结构图』与『逻辑流程图』,产品结构图展示的是产品的具体模块与功能,而逻辑流程图则说明了功能的具体步骤。将他们写清楚后,产品的骨架也搭建了起来。
另外,在画产品原型、补充产品逻辑的过程中,能够帮助产品同学理清产品的细节,确保产品在最初的设计上尽可能的完善与流畅,最大限度避免了后续出错的可能。
2. 辅助产品同学阐述产品需求
在进行需求评审的时候,需求文档是辅助产品同学阐述产品需求的重要支撑,类似于演讲的PPT。很多时候单靠口头描述,很难说清产品的具体细节与逻辑,如果结合着产品原型图,则会事半功倍。
十分建议将产品逻辑背后的『理由/产品解释』写到需求文档中,例如弹窗的『确定』与『取消』按钮,突出『确定』按钮的原因是想让用户完成期待的操作;添加『功能结果页』的原因是为了增加广告的展示频次等。
这样做有两个好处:一是能让产品同学在设计功能的过程中,不断的自我质疑,减少功能逻辑潜在的缺陷;二是能让别人更好理解需求本身,增加沟通的流畅性。
3. 减少沟通成本
需求文档对于设计与开发的同学来说,更像是一份参考文档或者需求词典。在他们困惑的时候,能够通过翻阅需求文档,解决疑惑点,从而省去了询问的过程。这就要求产品同学在编写需求文档的时候,要尽可能细致。
一份需求文档,除了原型图外,还应该写清楚『开发注意事项』与『设计注意事项』。开发注意事项包含页面间的跳转逻辑,每个组件的操作响应,操作之间的避让逻辑等;而设计的注意事项应该包含页面组件的表现优先级,组件的不同状态等。
另外,如果牵扯到广告变现,还要将广告的请求时机,展示时机说清楚。
在产品实现正式开始之前,产品同学一定要对开发同学与设计同学说清楚原型图中的每个要点,确保他们对于需求的理解和自己达成一致。这样在推进产品落地的过程中,才能充分发挥需求文档参考作用。
4. 产品存档
处于维护期的老产品,如果没有相关的文档,对于刚接手的人,简直是一个灾难。因为一款产品从发布到成熟,期间经历过各种坑,缺少对应的文档的解释,很多功能逻辑都无法理解,可能需要重新趟一次浑水,才能将老产品彻底的掌握。这个过程本身是痛苦的,成本也是巨大的。
但是,如果有比较完备的参考文档,接手过程就会顺利很多。另外,在遇到产品问题的时候,也能够通过翻阅备份文档,快速定位问题,极大提高了工作效率。
5. 需求文档构成元素介绍
1)逻辑流程图
- 将产品目标拆解实现步骤,将相关的步骤聚合为产品模块,每个模块之间低耦合,高聚类;
- 模块内使用流程图将具体的逻辑串联起来,每个模块内的逻辑流程基本上都可以从头到尾执行完毕,少有交错的情况;
- 如果有重复出现的逻辑流程,要使用子流程进行概括,并且在主流程中使用子流程进行替换;
2)原型图
- 画清楚页面的组件布局以及文案信息;
- 各个组件的展示优先级,通过组件的大小、颜色的深浅表现出来;
- 页面/组件的不同状态展示(选中状态);
- 页面之间的跳转逻辑(使用跳转);
- 每个组件的操作响应(使用简单的流程线);
- 广告的展示位置。
3)开发注意事项
- 控件的操作响应;
- 页面间的跳转逻辑;
- 状态更改的时机与条件;
- 广告的请求、展示逻辑。
4)设计注意事项
- 组件的优先级说明;
- 组件自身在各种场景下的变化。
5)产品解释
- 说清楚页面/组件要实现的产品目的
小结
虽然写出一份完整的需求文档,看起来要花很长的时间。但实际纯粹输出文档的时间并不多,大概一到两天的时间。真正耗费时间的是产品框架的搭建与逻辑的梳理,而这一块对于任何产品都是必不可少的。
需求文档如果做得比较完善,节省出的沟通成本是巨大的。在实践的过程中,一份完整的需求文档,加上充足的前期沟通,大致能节省后期70%的沟通成本。省下来的沟通成本所带来的是成倍的效率,因为沟通前后的精力转移成本是非常巨大的。
当然,需求文档的详略主要取决于团队成员对于项目的理解。
如果项目本身就很小,每个人对于项目都有着较深的理解,需求文档只需要简单的概述需求本身;对于比较大型的、复杂的产品,需求文档则越完善越好。
#专栏作家#
MING,个人公众号:MING的大航海,知乎专栏:产品见知录,人人都是产品经理专栏作家。一只专注于个人成长的产品汪,沉迷『方法论』,只分享值得收藏的『硬干货』!
本文原创发布于人人都是产品经理。未经许可,禁止转载。
题图来自 Unsplash,基于CC0协议。
相关推荐
- 腾讯开源框架TarsCpp-rpc设计分析-server(二)
-
2Tars协议2.1是什么借用官方说法:TARS编码协议是一种数据编解码规则,它将整形、枚举值、字符串、序列、字典、自定义结构体等数据类型按照一定的规则编码到二进制数据流中。对端接收到二进制数据流...
- 微服务调用为什么用RPC框架,http不更简单吗?
-
简单点,HTTP是协议,RPC是概念!实现RPC可以基于HTTP协议(Feign),TCP协议(Netty),RMI协议(Soap),WebService(XML—RPC)框架。传输过程中,也因为序列...
- go-zero:开箱即用的微服务框架(gin框架微服务)
-
go-zero是一个集成了各种工程实践的Web和rpc框架,它的弹性设计保障了大并发服务端的稳定性,并且已经经过了充分的实战检验。go-zero在设计时遵循了“工具大于约定和文档”的理...
- SOFARPC :高性能、高扩展性、生产级的 Java RPC 框架
-
#暑期创作大赛#SOFARPC是一个高性能、高扩展性、生产级的JavaRPC框架。在蚂蚁金服,SOFARPC已经使用了十多年,已经发展了五代。SOFARPC致力于简化应用程序之间的RPC...
- 自研分布式高性能RPC框架及服务注册中心ApiRegistry实践笔记
-
痛点1.bsf底层依赖springcloud,影响bsf更新springboot新版本和整体最新技术版本升级。2.eureka已经闭源,且框架设计较重,同时引入eureka会自行引入较多sprin...
- Rust语言从入门到精通系列 - Tonic RPC框架入门实战
-
Rust语言是一种系统级语言,被誉为“没有丧失性能的安全语言”。Rust语言的优势在于其内存安全机制,在编译时就能保证程序的内存安全。Tonic模块是Rust语言的一个RPC(RemoteProce...
- 腾讯开源框架TarsCpp-rpc设计分析-client(一)
-
前言Tars是腾讯开源的微服务平台,包含了一个高性能的rpc框架和服务治理平台,TarsCpp是其C++版本。对于以C++为主要开发语言,同时还想深入了解rpc和微服务框架具体实现的同学来说,Tars...
- 设计了一款TPS百万级别的分布式、高性能、可扩展的RPC框架
-
为啥要开发RPC框架事情是这样的,在开发这个RPC框架之前,我花费了不少时间算是对Dubbo框架彻底研究透彻了。冰河在撸透了Dubbo2.x和Dubbo3.x的源码之后,本来想给大家写一个Dubbo源...
- rpc框架使用教程,超级稳定好用,大厂都在使用
-
rpc是什么远程调用协议如何使用导入依赖<dependency><groupId>org.apache.dubbo</groupId><art...
- Layui 框架实战:动态加载 Select 与二级联动全解析
-
在现代Web开发中,下拉选择框(Select)是用户输入数据时不可或缺的组件。很多时候,我们需要的选项并非静态写死在HTML中,而是需要根据业务逻辑从后端动态获取。更有甚者,我们可能需要实现“...
- 15个能为你节省数百小时的前端设计神器,从UI库到文档生成
-
无论你是刚开始开发之旅的新手,还是疲于应付生产期限的资深程序员,有一个真理始终不变:正确的工具能彻底改变你的工作流程。多年来,我测试了数百个开发工具——有些实用,大多数平庸。但有一批免费网站经受住了时...
- Layui与WinForm通用权限管理系统全解析
-
嘿,小伙伴们,今天咱们来聊聊Layui和WinForm这两个框架在通用权限管理系统中的应用。别担心,我会尽量用简单易懂的语言来讲解,保证让大家都能跟上节奏!首先说说Layui。Layui是一个前端UI...
- 纯Python构建精美UI!MonsterUI让前端开发效率飙升
-
“无需CSS知识,告别类名记忆,11行代码实现专业级卡片组件”在传统Web开发中,构建美观界面需要同时掌握HTML、CSS、JavaScript三剑客,开发者不得不在多种语言间频繁切换。即使使用Boo...
- WebTUI:将终端用户界面(TUI)之美带到浏览器的CSS库
-
在当今Web技术飞速发展的时代,界面设计愈发复杂多样。然而,随着现代化工具的广泛使用,一些开发者开始回归极简风格,追求一种简洁而富有韵味的设计。WebTUI正是这样一款CSS库,它将经典的终...
- 人教版二年级下册生字描红汇总(拼音+笔顺+描红),可打印!
-
可定制内容,评论区留言。本次整理的为人教版二年级下册所有生字,共计300个;写字是小学阶段一项重要的基本功训练,把汉字写得正确、工整、美观,可以提高运用汉字这一交际工具的准确性和效率。对小学生进行写字...
你 发表评论:
欢迎- 一周热门
- 最近发表
-
- 腾讯开源框架TarsCpp-rpc设计分析-server(二)
- 微服务调用为什么用RPC框架,http不更简单吗?
- go-zero:开箱即用的微服务框架(gin框架微服务)
- SOFARPC :高性能、高扩展性、生产级的 Java RPC 框架
- 自研分布式高性能RPC框架及服务注册中心ApiRegistry实践笔记
- Rust语言从入门到精通系列 - Tonic RPC框架入门实战
- 腾讯开源框架TarsCpp-rpc设计分析-client(一)
- 设计了一款TPS百万级别的分布式、高性能、可扩展的RPC框架
- rpc框架使用教程,超级稳定好用,大厂都在使用
- Layui 框架实战:动态加载 Select 与二级联动全解析
- 标签列表
-
- 框架图 (58)
- flask框架 (53)
- quartz框架 (51)
- abp框架 (47)
- jpa框架 (47)
- springmvc框架 (49)
- 分布式事务框架 (65)
- scrapy框架 (56)
- shiro框架 (61)
- 定时任务框架 (56)
- java日志框架 (61)
- JAVA集合框架 (47)
- mfc框架 (52)
- abb框架断路器 (48)
- ui自动化框架 (47)
- beego框架 (52)
- java框架spring (58)
- grpc框架 (65)
- tornado框架 (48)
- 前端框架bootstrap (54)
- ppt框架 (48)
- 内联框架 (52)
- cad怎么画框架 (58)
- ssm框架实现登录注册 (49)
- oracle字符串长度 (48)