APP推广合作
联系“鸟哥笔记小乔”
写好需求文档的 9 个关键细节,你一定要知道!
2024-08-28 13:36:04

最近看下属写的产品文档,逻辑混乱又贼难懂,估计 GPT 都读不了。

预计 10 分钟左右的评审,硬生生拖改了几天,真的差点被气哭。。

所以含泪写了几个小时,总结出我写需求文档的 9 个工作细节:颜色对比、大小差异、形状区分、符号标记、避免歧义、图表呈现、维度提炼、概念封装、领域知识。

如果你工作中也遇到了类似问题,不妨看看。

颜色对比

通过颜色深浅、色域对比,可以让人一下就抓到文档重点。

日常撰写需求文档时,你可以试着用红字标记重要内容或说明。

我有一个习惯是,会用蓝字去表示一些可跳转的页面或交互。

大小差异

在一些 UI 设计规范中,一般有字体大小的使用规则。

例如 22px 用于页面标题、17px 用于列表标题、14px 一般是列表描述文字。

其实我蛮建议初级的产品经理,去学习一两个组件库的设计规范,包含“字体图标、组件说明、颜色大小”等内容。

毕竟产品经理掌握组件库,是一种快速提升审美能力的途径。

形状区分

假设文档通过颜色对比、大小差异等优化后,呈现的内容还是难以理解和吸收,你可以尝试增加形状这一维度,进一步降低文档的阅读难度。

就像我们熟悉的流程图,绘制时会用圆角矩形代表起始节点、矩形代表流程动作、菱形代表条件判断。

符号标记

符号标记,指的是通过一些特殊符号,去突出重要内容的层次,加深文档读者的印象。

我一般喜欢用中英文间隔、 “”【】「」等符号,来突出文档中的一些重要内容。

避免歧义

我发现初中级产品在撰写文档时,最容易犯的高频错误,就是文档中出现的各种内容歧义。

例如列表的某个数据,需要显示 clients 表的 name 字段。这个表又有各种类似的数据 full_name、first_name、display_name。

如果你在文档中写的规则是“显示客户名称”,那前后端联调、测试验收时大概率会出各种小问题。

他们有可能会懵逼卡壳一两个小时,然后去猜、去问客户名称到底是指什么?

到底是用户表、游客表还是客户表呢?哦搞了半天原来是 clients 客户表。那客户名称这个字段,又是 clients 客户表的全名、名称、姓氏这些中文翻译,对应的哪一个英文字段呢?

运气好的话,前后端经过一番折腾,或许能显示你期望的内容。

但大多数情况,由于你完全不懂其中的数据逻辑和细节,所以只要面上过得去没有明显 BUG,你可能就草草验收了事,或者验收时出错,你连问题在哪排查都不知道。

我说的这种情况,其实只是最基础、简单的一个表数据出错。

可以想象更复杂的财务账单数据,要是数据能对上的话,那应该是平时有烧香拜佛、买中彩票了吧。

图表呈现

一图胜千言,能用图表的尽量图表呈现。

比如某些复杂的知识概念,可能需要几百字才能阐述清楚,如果通过图片、表格进行呈现,或许看的人几分钟就完全明白了。

我记得刚做产品时,就遇到了对产品新人来说,比较复杂的订单状态定义,当时尝试了文字描述,我写的麻烦、耗时不说,看得人也非常费劲。

后来学会了 UML,用几分钟画个简单的状态图直接搞定,清晰直观。

维度提炼

没有经过优化加工的内容,可以说只是一堆无序、混乱的信息。

要让这些信息变成通俗易懂、持续复用的知识,你需要把它们进行总结提炼,并找出内容的差异和共性,然后抽象出维度属性。

最后将信息按维度,进行整理归纳、分门别类,这个思考过程可以称为维度提炼。

脱不花老师在《沟通的方法》中,分享过一个职场的倾听方法,叫结构化倾听。

即把沟通中的话题,提炼成了情绪、事实和期待等 3 个维度。

概念封装

概念封装,核心是将内容进行压缩和简化,提升内容的复用率。

具体指的是用一个简单的概念,去表示一系列关联度较高、重复使用的复杂内容。

概念封装的好处是,一次定义,持续复用。

像我的需求文档模版中,常用的全局说明、名词解释、公式复用、参数说明、公共组件、交互解耦等文档模块,就是概念封装的一些使用场景。

领域知识

如何才能快速提升文档的沟通效率?其实核心在于,呈现领域知识。

简单来说,就是当面对不同的读者时,你要针对性地呈现专业内容。

公司的老板时间都很宝贵,所以你要在一两分钟内,就让他快速 Get 到文档重点。这时候内容就要侧重于简洁,大白话讲清楚文档的核心概念。

如果是针对业务方,一方面你要表达得简单易懂,另一方面又要呈现专业的业务知识,重点是快速达成双方共识。

当面对前后端团队时,你还要基于开发视角和技术知识,撰写便于他们理解的文档。

内容不限于写清楚数据处理、异常分支等复杂的规则交互等。

很多初级产品经理一定会遇到这种情况,自己花一小时写了一堆洋洋洒洒的文档说明,开发居然一个字都不看。

其实这是因为文档呈现的内容,并不是开发通用语言,理解起来太费劲了。

更好的做法是,找到类似 UML 这种统一建模语言,画几个状态图、流程图来呈现你的需求,既专业又高效。

总结

产品经理在日常工作中,如何才能让撰写的需求文档,显得既清晰、又专业?

核心在于做好这 9 点:颜色对比、大小差异、形状区分、符号标记、避免歧义、图表呈现、维度提炼、概念封装、领域知识。

好夕雷
公众号二维码
分享到朋友圈
收藏
收藏
评分

综合评分:

我的评分
Xinstall 15天会员特权
Xinstall是专业的数据分析服务商,帮企业追踪渠道安装来源、裂变拉新统计、广告流量指导等,广泛应用于广告效果统计、APP地推与CPS/CPA归属统计等方面。
20羽毛
立即兑换
一书一课30天会员体验卡
领30天VIP会员,110+门职场大课,250+本精读好书免费学!助你提升职场力!
20羽毛
立即兑换
顺丰同城急送全国通用20元优惠券
顺丰同城急送是顺丰推出的平均1小时送全城的即时快送服务,专业安全,准时送达!
30羽毛
立即兑换
好夕雷
好夕雷
发表文章22
产品之外
千万营收产品经理,分享产品相关干货。
确认要消耗 羽毛购买
写好需求文档的 9 个关键细节,你一定要知道!吗?
考虑一下
很遗憾,羽毛不足
我知道了

我们致力于提供一个高质量内容的交流平台。为落实国家互联网信息办公室“依法管网、依法办网、依法上网”的要求,为完善跟帖评论自律管理,为了保护用户创造的内容、维护开放、真实、专业的平台氛围,我们团队将依据本公约中的条款对注册用户和发布在本平台的内容进行管理。平台鼓励用户创作、发布优质内容,同时也将采取必要措施管理违法、侵权或有其他不良影响的网络信息。


一、根据《网络信息内容生态治理规定》《中华人民共和国未成年人保护法》等法律法规,对以下违法、不良信息或存在危害的行为进行处理。
1. 违反法律法规的信息,主要表现为:
    1)反对宪法所确定的基本原则;
    2)危害国家安全,泄露国家秘密,颠覆国家政权,破坏国家统一,损害国家荣誉和利益;
    3)侮辱、滥用英烈形象,歪曲、丑化、亵渎、否定英雄烈士事迹和精神,以侮辱、诽谤或者其他方式侵害英雄烈士的姓名、肖像、名誉、荣誉;
    4)宣扬恐怖主义、极端主义或者煽动实施恐怖活动、极端主义活动;
    5)煽动民族仇恨、民族歧视,破坏民族团结;
    6)破坏国家宗教政策,宣扬邪教和封建迷信;
    7)散布谣言,扰乱社会秩序,破坏社会稳定;
    8)宣扬淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪;
    9)煽动非法集会、结社、游行、示威、聚众扰乱社会秩序;
    10)侮辱或者诽谤他人,侵害他人名誉、隐私和其他合法权益;
    11)通过网络以文字、图片、音视频等形式,对未成年人实施侮辱、诽谤、威胁或者恶意损害未成年人形象进行网络欺凌的;
    12)危害未成年人身心健康的;
    13)含有法律、行政法规禁止的其他内容;


2. 不友善:不尊重用户及其所贡献内容的信息或行为。主要表现为:
    1)轻蔑:贬低、轻视他人及其劳动成果;
    2)诽谤:捏造、散布虚假事实,损害他人名誉;
    3)嘲讽:以比喻、夸张、侮辱性的手法对他人或其行为进行揭露或描述,以此来激怒他人;
    4)挑衅:以不友好的方式激怒他人,意图使对方对自己的言论作出回应,蓄意制造事端;
    5)羞辱:贬低他人的能力、行为、生理或身份特征,让对方难堪;
    6)谩骂:以不文明的语言对他人进行负面评价;
    7)歧视:煽动人群歧视、地域歧视等,针对他人的民族、种族、宗教、性取向、性别、年龄、地域、生理特征等身份或者归类的攻击;
    8)威胁:许诺以不良的后果来迫使他人服从自己的意志;


3. 发布垃圾广告信息:以推广曝光为目的,发布影响用户体验、扰乱本网站秩序的内容,或进行相关行为。主要表现为:
    1)多次发布包含售卖产品、提供服务、宣传推广内容的垃圾广告。包括但不限于以下几种形式:
    2)单个帐号多次发布包含垃圾广告的内容;
    3)多个广告帐号互相配合发布、传播包含垃圾广告的内容;
    4)多次发布包含欺骗性外链的内容,如未注明的淘宝客链接、跳转网站等,诱骗用户点击链接
    5)发布大量包含推广链接、产品、品牌等内容获取搜索引擎中的不正当曝光;
    6)购买或出售帐号之间虚假地互动,发布干扰网站秩序的推广内容及相关交易。
    7)发布包含欺骗性的恶意营销内容,如通过伪造经历、冒充他人等方式进行恶意营销;
    8)使用特殊符号、图片等方式规避垃圾广告内容审核的广告内容。


4. 色情低俗信息,主要表现为:
    1)包含自己或他人性经验的细节描述或露骨的感受描述;
    2)涉及色情段子、两性笑话的低俗内容;
    3)配图、头图中包含庸俗或挑逗性图片的内容;
    4)带有性暗示、性挑逗等易使人产生性联想;
    5)展现血腥、惊悚、残忍等致人身心不适;
    6)炒作绯闻、丑闻、劣迹等;
    7)宣扬低俗、庸俗、媚俗内容。


5. 不实信息,主要表现为:
    1)可能存在事实性错误或者造谣等内容;
    2)存在事实夸大、伪造虚假经历等误导他人的内容;
    3)伪造身份、冒充他人,通过头像、用户名等个人信息暗示自己具有特定身份,或与特定机构或个人存在关联。


6. 传播封建迷信,主要表现为:
    1)找人算命、测字、占卜、解梦、化解厄运、使用迷信方式治病;
    2)求推荐算命看相大师;
    3)针对具体风水等问题进行求助或咨询;
    4)问自己或他人的八字、六爻、星盘、手相、面相、五行缺失,包括通过占卜方法问婚姻、前程、运势,东西宠物丢了能不能找回、取名改名等;


7. 文章标题党,主要表现为:
    1)以各种夸张、猎奇、不合常理的表现手法等行为来诱导用户;
    2)内容与标题之间存在严重不实或者原意扭曲;
    3)使用夸张标题,内容与标题严重不符的。


8.「饭圈」乱象行为,主要表现为:
    1)诱导未成年人应援集资、高额消费、投票打榜
    2)粉丝互撕谩骂、拉踩引战、造谣攻击、人肉搜索、侵犯隐私
    3)鼓动「饭圈」粉丝攀比炫富、奢靡享乐等行为
    4)以号召粉丝、雇用网络水军、「养号」形式刷量控评等行为
    5)通过「蹭热点」、制造话题等形式干扰舆论,影响传播秩序


9. 其他危害行为或内容,主要表现为:
    1)可能引发未成年人模仿不安全行为和违反社会公德行为、诱导未成年人不良嗜好影响未成年人身心健康的;
    2)不当评述自然灾害、重大事故等灾难的;
    3)美化、粉饰侵略战争行为的;
    4)法律、行政法规禁止,或可能对网络生态造成不良影响的其他内容。


二、违规处罚
本网站通过主动发现和接受用户举报两种方式收集违规行为信息。所有有意的降低内容质量、伤害平台氛围及欺凌未成年人或危害未成年人身心健康的行为都是不能容忍的。
当一个用户发布违规内容时,本网站将依据相关用户违规情节严重程度,对帐号进行禁言 1 天、7 天、15 天直至永久禁言或封停账号的处罚。当涉及欺凌未成年人、危害未成年人身心健康、通过作弊手段注册、使用帐号,或者滥用多个帐号发布违规内容时,本网站将加重处罚。


三、申诉
随着平台管理经验的不断丰富,本网站出于维护本网站氛围和秩序的目的,将不断完善本公约。
如果本网站用户对本网站基于本公约规定做出的处理有异议,可以通过「建议反馈」功能向本网站进行反馈。
(规则的最终解释权归属本网站所有)

我知道了
恭喜你~答对了
+5羽毛
下一次认真读哦
成功推荐给其他人
+ 10羽毛
评论成功且进入审核!审核通过后,您将获得10羽毛的奖励。分享本文章给好友阅读最高再得15羽毛~
(羽毛可至 "羽毛精选" 兑换礼品)
好友微信扫一扫
复制链接