七坑没有可读性的都是耍流氓
写PRD并不是产品经理的全部工作,但却是不可少的一部分,一份可读性的PRD对一个项目团队来说是至关重要的。
突发事件
昨天编辑了一篇纯逻辑修改的文档,交付开发后,开发方向偏离,后台大量订单数据出错出错。
我立马叫停开发人员,交流之后,发现开发人员错误理解了PRD文档。开发人员在阅读文档的时候直接看掉了两个字。
后来我自己回去阅读的时候也看错了,说明我文档是不易读。所以一方面叫开发人员停下来修复数据出错的地方,一方面重新整理文档。
下面我就介绍一下我在梳理文档过程中发现的几个坑。
第一坑名词交流混乱
这是昨天文档中最大的问题,因为后台是管理订单的,所以会有大量的时间结点,但是目前只有两个时间结点有自己的专属名字。其他的时间结点的叫法都是今天一个样,明天一个样。
所以我在写文档的时候就按照自己的叫发来写文档,其中就有一系列相似名称的时间结点叫做服务时间、次服务时间、官方服务时间,技术同学在开发的时候,直接把官方服务时间的官方二字看掉了。
看错后就直接对服务时间的先关内容进行大刀阔斧的修改,所以就导致后台订单数据错乱。于是乎经过交流,终于重新定名服务时间、订单时间、官方时间。
关键词命名的注意点:
整个团队要将关键词进行统一,最好创建规范性名词解释列表;
关键词命名时,同一个模块、流程中的词语里边相同字的使用不要超过50;
还有产品设计各个环节中,关键词的一致性,也是需要注意的。
第二坑专业名称重复出现
昨天在写文档的时候,为了使每一个名词都能精确的定位到每个点上,所以每一个名词都使用专业名称来表示,全篇PRD专业名称横飞。由于昨天写的文档是属于纯逻辑性的文档,所以大量在专业名称充斥的情况下,整篇文章的可读性极差。
专业名称使用注意:
同一句话中,能使用代词来代指句子中的专业名称的时候,尽量使用代词表示,因为代词更口语化,也更容易让人理解。
如果使用代词会让整句话产生歧义,那就一定不要使用代词;
使用代词可以增加可读性,使用专业名称可以增加准确性,所以只有在恰到好处的地方进行敲到好处的表达,才能把文档的易读性和准确性最大化。
第三坑行文逻辑不清晰
在写开发文档的时候,凭着直觉来写文档,在写之前并没有梳理清楚其中的逻辑,以至于最后写出来地文档逻辑混乱,各个板块互相穿插。
在撰写文档前,首先自己要清楚整个功能的流程,这个肯定是毋庸置疑的。但是,我们在写文档的时候,可能就没有这么在意行文的逻辑,全凭自觉来撰写。
所以在写文档的时候,不仅仅需要理清整个产品、功能的逻辑,还需要为整篇文章的结构和行为逻辑进行提前的思考,不然产出的文档可读性也很差。
第四坑详细得臃肿
在写PRD时,为了想一次性把问题说清楚,让程序员能一次性把文档理解透。所以会把一个问题解释得很详细,从而使得文档变得很臃肿。
这不是认真,这其实是一种懒惰,因为想用文档砸给程序员,让他们自己去理解产品,不想和程序员进行过多的交流和文档解释。
其实在实际工作中,我发现有就算你写得再详细,如果不进行口头介绍,程序员想把如此臃肿的文档理解清楚也非常不容易。所以,如果能用流程图来表述,就不需要长篇累述;如果能先进行产品大致的介绍,让大家先理解整个思路,就不需要文字上过于累赘的表述。
产品文档应该做到考虑全面,逻辑清晰,语言精练
第五坑文档排版不易读
原来才开始写文档的时候,完全不知道什么排版,在无数次打磨自己的格式后,开始对排版有了一点自己的理解。
如果说排版有什么技巧,我想可能是这几个:
以功能划分大板块,大板块标题醒目。
把大板块简单拆分,并用小标题区分。
用点号罗列观点,不要写成一大段。
对于文档排版,统一文字格式后,做好以上几点就能确保文档基本整洁和可读性。但是排版是个长期打磨和锻炼的事情,必须要经常锻炼,才能有一套自己的合理的排版风格。
第六坑重点内容不突出
重点加得非常随意,就会造成两个结果,重点不突出和重点不够重点。
所以,文档中应该标记重点,但也要注意:
重点最好为重要的动词、转折词、新名词和关键逻辑判定词等。
重点内容不在于多,更在于精,满篇重点则是没有重点。
第七坑不用程序员喜欢的形式写文档
最后,特别重要的一点,也是不可不说的一点,那就是使用程序员容易理解的、喜欢的方式来写文档。
程序员更喜欢看到能用公式来展现各个数据或者信息之间的关系;
了解程序员编程的时候常用的逻辑,多以这种逻辑术语来写文档,这样程序员就更能理解;
多用分句,别用连句,一个分句表达一个意思就可以了。
能用配流程图的,千万别只写文字。
中职学校教学质量评价研究摘要:笔者通过调查及在教学实践中不断探索,对中职学校教学质量评价进行了一系列的改革与创新,提高了人才培养质量。关键词:中职学校教学质量评价人才培养课题:本文系山东省……
互联网对企业财务管理的影响研究奚钲峰魏琪政摘要:2015年,互联网快速崛起,商业在其影响下变得更多样化,企业对财务管理也更重视。传统的财务管理模式在现阶段已不能满足企业发展需求,改进企业财务管理模式势……
关于做好年防暑降温工作的管理措施一是消除防暑设备设施的安全隐患。暑期前车间、工区,应对值班室、会议室、宿舍、工作间等处所的电扇、开关、闸刀、纱门、纱窗、空调等设备设施进行一次全面认真的检查。对不符合安全技术要……
包头文化产业发展的现状问题与对策摘要:本文分析了包头文化产业发展的基本现状和存在的主要问题,并结合包头实际情况,提出了促进文化产业发展的对策。关键词:包头;文化产业包头文化产业远未成为支柱产业,但……
软法视域下的基层协商民主制度反思摘要:基层协商民主是我国民主政治的微观基础,但在理论和实践上仍有很大的发展空间。通过分析《‘五议两公开工作法》和《宁海县村级小微权力36条》反思基层公众参与协商的制度发展空间,……
基建龙头获益宽松活水来袭。根据高层会议的定调,大水漫灌坚决不能搞,但稳健的货币政策也要松紧适度。在会议当天,央行开展了历史上单次最大规模的中期借贷便利(MLF)操作,1年期5020亿元。……
如何自我营销在本文中:开始在线营销找工作中的营销营销是传播关于一件事情或想法的手段,以期获得的良好的印象并最终成为顾客的过程。正如每一个企业、组织、公众人物和机构使用的营销技巧以给个……
麻省理工明星课程教你如何有效深度思考工作太累是因为缺乏休息?发胖的原因是吃太多和没运动?公司销售业绩下滑,是因为没找到提高销量的好方法?陷入思维定式,失去深度思考的能力,那么你的解决方案只能治标……
中华文明之待人接物基本礼仪精美图配文中华文明之待人接物基本礼仪人生社交26忌1、不注意自己说话的语气,经常以不悦而且对立的语气说话。2、应该保持沉默的时候偏偏爱说话。3、打断别人的话。……
运动的个好习惯你有几个正安精简版积极运动者的10个好习惯1:化身晨间跑者2:规律有计划性地肌力训练3:多吃蔬菜水果4:运动前暖身、运动后放松5:一周安排一天3CFre……
分享一个可以实战的量化交易策略一个交易系统都有哪些元素?应该如何分辨交易系统的优劣?今天起,我将介绍一些有实战价值的量化交易系统,这些系统都经过了时间的沉淀,是可以盈利的系统,希望能给大家以启迪,帮助大家更……
诸葛亮缺少什么爆笑一提到诸葛亮,无人不知无人不晓,三岁孩童也知三个臭皮匠抵得一个诸葛亮的俗语。羽扇轻摇,运筹帷幄,决胜于千里之外,隆中对、空城计、赤壁之战等一个又一个的锦囊妙计,令多少世人拜倒在……
农贸市场的鸡蛋有营养吗鸡蛋是人们生活中食用频率最高的食物之一,非常好吃。那么农贸市场的鸡蛋有营养吗?鸡蛋的功效与作用有哪些1。健脑益智:鸡蛋对神经系统和身体发育有很大的作用,其中含的胆碱……
哺乳背心有必要买吗刚生完宝宝的妈妈们应该都有一个困扰吧,因为刚生了宝宝不能穿很紧的内衣,这样喂宝宝母乳的时候也很是不方便,所以很多宝妈会选择哺乳背心来进行哺乳。那么哺乳背心有必要买吗?下面本站就……
土壤污染会导致农作物减产吗土壤污染物大致可分为无机污染物和有机污染物两大类。无机污染物主要包括酸、碱、重金属,盐类、放射性元素铯、锶的化合物、含砷、硒、氟的化合物等。有机污染物主要包括有机农药、酚类、氰……
网吧电脑病毒如何清除电脑病毒具有传播性、隐蔽性、感染性、潜伏性、可激发性、表现性或破坏性。网吧电脑如果中病毒,就会使计算机运行过慢,影响上机速度,更有甚者会盗取上网者的QQ号、微信号,导致个人信息……
茄子青枯病的防治方法有哪些茄子青枯病的发病特点:该病属于细菌性病害。病原细菌主要在土壤中越冬,次年随雨水、灌溉水传播,从寄主根茎伤口侵入,首先在导管里繁殖蔓延。病菌生长适宜温度30到37摄氏度。病菌脱离……
孕妇旅游期间注意事项准妈妈进入孕期之后,不代表只能在自家附近的公园走动,还是可以选择一些较方便、安全的旅游景点作定点旅游,适当的出游踏青可以为准妈妈带来好心情。不过,在行前也要确认自己的身体状况,……
红豆杉常见病虫害防治措施有哪些红豆杉的整个株行非常的挺拔清秀,十分的美观,而且能够耐得住修剪,可以修剪成自己想要的盆景造型,而且它的果实红红的,非常的可爱,在养护的时候碰上病害,需要及时的防治,那如何防治农……
儿童早期性教育有多重要儿童早期性教育有多重要,大部分的孩子从3岁开始就会对我从哪里来的这样的问题感兴趣,随着年龄的增大就会提出一系列与性有关的问题,比如:我是从哪里来的?我是怎样进到妈妈的肚子里去的……
闻杀虫剂时间长了会中毒吗在农村,人们都喜欢自家养一些牲畜,因为自家养的牲畜不仅可以吃还可以卖了当钱用,但是大家都知道牲畜的粪便经常会引来一些蚊虫,导致家里哪哪都是蚊虫,苦不堪言,而杀虫剂正式对付蚊虫的……
慢跑对颈椎有好处吗跑步减肥一定要选好鞋和跑道,如果没有条件在合适的跑道上跑,至少鞋一定要够柔软有弹性。膝盖里面的软组织是很脆弱的部位,长期的冲击会磨损它,而且它一旦磨损很难长好,我们在慢跑时该注……
产后怎样恢复子宫妈妈们在怀孕到分娩的整个阶段中,子宫的变化是非常大的,由于胎儿的慢慢增大,子宫也逐渐被撑大,等到生完孩子后,子宫就自动开启了修复程序,很多妈妈都恨不得恢复到孕前的状态,那么产后……
给孩子补充维生素的方法春天是孩子身体发育的好季节,在春天孩子的营养吸收也比较快,所以家长必须要利用春季帮助宝宝补充一些营养元素,当然最常见的就是要积极的补充维生素了,下面给孩子补充维生素的方法。……