服务粉丝

我们一直在努力
当前位置:首页 > 财经 >

产品经理【文档规范】基础要求总结丨建议收藏

日期: 来源:PMTalk产品经理社区收集编辑:王掌柜的大排档

点击 ▲ PMTalk 关注,和 21万产品经理一起成长

国内最会做产品、运营沙龙的产品经理社区

正文共:3506 字 8 图 预计阅读时间:9 分钟

全文概览

01、文档的格式规范(字体、标题、图片、目录)

02、文档的内容规范(错别字、书面语、文件名)

03、其他需要注意的细节(6条)
01、文档的格式规范
格式规范性主要包含字体、段落标题、段内标题、图片、目录这几类内容。
1、字体问题
字体最关键是需要全文统一,我们可以按“正文字体”、“小标题字体”、“表格内字体”、“补充说明字体”、“重点突出字体”来分类,并保证每个类别的全文字体一致。
表格内的字体还要考虑字体大小是否会让表格排序“失真”或“凌乱”,表格的首行标题建议加粗、居中。章节的各级标题一定要使用格式刷来统一维护。
很多文档不同的段落字体大小、样式都会有些偏差,究其原因还是作者没有检查的意识,也没有在完成复制粘贴后顺手用格式刷统一的习惯。
2、标题编号问
各级标题在用格式刷统一的过程中,非常容易出现一些小错误。
比如级别错误,下图便是将四级标题,误刷成三级标题。

比如没有重新开始编号,下图显然是将规则复制粘贴过来之后,没有重新编号。

一个文档中段落内的小标题也尽量采用一种格式,比如选择使用(1)(2)(3),就不要再使用①②③,除非在文档中有多处不同级别的排序需求再考虑多种小标题样式。
3、图片格式问题
文档中的图片要居中,如果某个章节有多张图片连续,则需要给每个图片附上文字说明。
而且图片的大小也需要微调,尤其是一些图片复制进去之后很大、很模糊,此时把图片缩小成尽量全文统一的大小则显得很有必要。

尤其是一些移动端截图,复制到文档之后可能会“又细又长”,这时我们一定要随手调整大小。
4、文档的目录问题
目录记得及时更新,我们经常遇到内容修改之后没有更新目录直接提交的情况。
也要记得把目录的字体、间距调整到适当,因为很多默认的目录格式说实话,挺丑的。

以上这些细节,都是文档的格式规范要求,每一条单独来看可能都知道要这样做,或者也很简单觉得可以做到,但当这些问题汇集到同一个文档时,就是“阅读者的灾难伊始”
02、文档的内容规范性
关于文档的内容,因为不同的行业和用途有不同的内容要求,本文侧重点不在于内容如何整理,而是无论哪种内容,我们都需要检查、规避的常见问题
首先,也是我认为最最重要的一点:错别字
在智能输入法普及的今天,我们日常的文字交流中充满了错别字,而这些错别字一旦在产品工作者的产出物中出现,会非常影响“印象分”,同时也会被质疑此人的细心、认真程度
大家也都知道出现错别字不好,但苦于难以察觉,但这并不是我们任由错别字存在的理由。所以对于错别字,我有以下几点建议:
1、换一个相对智能的输入法
毕竟一个好的输入法能够记住我们常用的专业术语,能够在拼写错误时给出智能提示,操作系统默认的输入法很难达到这个效果。
我曾经发现一位经常打错别字的小伙伴,就是一直在使用mac的默认输入法,换了搜狗之后能降低大约60%的错字情况。
错别字很烦银,比如当你读到这段话的时候,能否一言就看出短短几十个字里饱含着多少问题呢?我在看新同事写的文档时,关注的第一要素就是有么有矬子和语句不通顺的标大。
2、在日常生活中多注意
平时打字聊天的时候就养成不打错字的习惯,发出去的内容自己再扫一眼,如果出现了错别字及时改正,我认为这是一件很基础的事情。
但是很多人都不在意,甚至被人多次指出之后也只是呵呵一笑,找个宽慰自己的理由,这些人一定写不出合格的产品文档
3、团队内可采取一些奖惩措施
比如在关键文档中出现错别字之后,在团队内部发红包,或者当你看到其他同学的文档有错别字时及时提醒。
总之一定要采取一些措施,让大家重视起来,养成日常检查的习惯,渐渐地错别字一定会越来越少。
4、自己一定要通读几遍
一个大段落写完之后,一定要重新读至少一遍,一方面检查错别字,另一方面检查是否存在语义表达等问题。
自己要对自己的成果负责。
5、可以让同事帮忙检查
有时很难发现自我产生的错误,因为会陷入惯性思维怪圈。因此找同事帮忙检查也是不错的方式。
而且相互帮助,去识别对方的错误,也能在很大程度上检视自己,提升错字意识。

以上这些方法都可以快速运用,几乎“0门槛”,逐渐我们会提升错别字的敏感程度,快速识别错误,并且能够总结出一些“高频错字”。
多管齐下,立竿见影
其次,在内容规范性上,还有一点很重要:书面语的表达
虽然经过几百年的发展,文字表达从最初的文言文变成了白话文,但白话文也不代表等同于口语化。
我也见到过一些同行在吐槽文档中为什么一定要用书面语,既费时又费力。而我个人认为原因在于这八个字:正式、规范、严肃、严谨
其实如果是团队内部的文档,只要领导没意见,你们愿意怎么搞就怎么搞。一旦涉及到对外输出,逻辑严谨、表达清晰、结构明确的内容便是基础。
在此我列举几个关键点,建议大家在写文档时尽量规避这些问题。
1、表达简洁易懂
当然,可能有些文档就是需要复杂严谨(比如专利申请文档),读起来非常拗口但确实挑不出逻辑漏洞。
不过我们大部分接触的文档,还是尽量简单、易懂,从而让读者尽快理解你想表达的意思
比如:
  • 善于使用逻辑连接词:“因此”“进而”“所以”“反而”“除非”;
  • 简化短语,将“什么什么的时候”改为“什么什么时”;
  • 复杂逻辑采用分段、编号、配图等方式更直接地展现。
2、避免歧义用词
“一千个人心中有一千个哈姆雷特”,很多词语都有多面性,当使用不恰当时,非常容易造成读者的歧义。
所以我们在使用这些词语时,要脱离自己的惯性思维,以用户视角来审视这段话是否准确
  • 比如“XX等功能”,这个等字就很微妙。如果是售前类的文档,“等”没问题。如果是交付类的文档,“等”就很容易给后续的验收挖坑;
  • 比如“单位”这个词,既可代表计量单位,又能代表公司、用工单位。当然结合文档的上下语境能够体会出其中的含义,但在一段文字内,如果出现同一个词代表不同含义的,一定要加以说明,或者换一种表达形式。
  • 我还在一本书中发现“资产管理”这个名词很有歧义。大多数人会认为是办公资产、固定资产之类的“资产”管理系统,而作为金融从业者,第一反应会是“资金类的金融资产”管理系统,这两种系统完全不同。

所以避免内容的“二义性”是内容规范中非常重要的一点。
3、语义要直接,别让对方反复理解
这里和表达简洁易懂有几分类似,但第一条更倾向于别说废话,此条更倾向于业务逻辑尽量直接。
比如:
  • 把双重否定词(不得不)改为肯定(就);
  • 把“穷举”改成“除了”(在条件1、2、3、4、5、6、7、8的情况下,改成除了条件9、10的情况)

最后,关于内容规范性需要强调的是:文件命名规范
文件名一定不能随便起,尤其是要发给客户的文档。最好能够通过文件名能让读者明白此文档的目的或核心内容。
而且文件名最好能够和正文内的大标题保持一致,尽量在文件名中包含客户的简称、版本号、或者修改日期,其中修改日期一般出现在后续版本修改之后再添加。
比如:
  • 【公司简称】产品名称+用途+版本号
  • 【客户名称】+公司简称+产品名称+用途+版本号
  • 产品名称+用途+日期-备注
  • ...
总之,不要忽略文档名称的重要性,如果起一个不专业的名字,可能对方都不会打开看就驳回了。

以上便是我对于“内容规范性”的总结,希望我们能给勤加练习,多多注意。
03、其他的注意事项
还有一些其他的注意事项,简单整理供大家参考:
1、我们在写文档时,有些没写完的内容会习惯性标注出来,等到后续再完善,但此时的标注一定要很方便的让你快速找到。比如采用特定的关键词(todo、待完善),或者插入批注。
不要仅仅增加一个字体颜色或者背景色来标注。因为文档如果很长、如果没有逐行检查,很有可能会遗漏。
2、文档内容如果不是特别多,在多人协作时尽量使用【修订模式】,避免协作过程中出现冲突或疏忽而产生内容问题。最终合并时再把修订内容逐一核对,可以避免很多协同过程的麻烦。
当然,如果文档较长,修订模式会很卡,多人协作要么采用一些其他协同工具,要么做好分工,避免同一部分多人修改的情况。
3、较长的文档,建议增加页码。
4、最好有“版本修订记录”,但不是必须。毕竟修改记录后期维护起来非常繁琐。如果文档版本变动频繁或者有追溯的必要性时,再增加修订记录也可以。
关于修订记录还需要注意一点:修订的内容是否适合让接收人看到?至于为什么,你可以细品一下,我就不多说了
5、从其他文档复制进来的内容,一定要进行关键词检索。可以日常维护一个“关键词词库”,包含其他客户的名称、其他产品的名称、以及易错的关键词。待文档完成后,进行全局检索,大概率会有“惊喜”。
6、客户给的模板,尽量不要在结构上大改。有些章节如果没有内容,或者不知道怎么写,可以标注“不适用”。但是如果你直接把章节删掉,后续交付、审核时可能会被纠错。当然,删掉的前提也要和客户沟通清楚。

作者:王掌柜的大排档
分享:PMTalk产品经理社区

////// END //////


近期产品经理必读:

做了五年产品,这十种产品思维最重要

B端产品经理必知:如何将第三方错误信息转化为友好型提示?

(PMTalk签约作者:vitamin)

产品经理如何绘制贴合需求的原型

「微信键盘」深度分析——产品交互设计

(PMTalk签约作者:沐风)

关注PMTalk:
PMTalk产品经理社区,成立于2016年,已经有21万产品经理注册。一每年都会在北上广深杭成城市举办产品经理、运营、设计师沙龙。目已经有超过600名产品经理相关的签约作者入驻,关注PMTalk参加同行的线下沙龙!随时找产品、运营同行!

欢迎添加 ⭐️  星标,获取每天推荐知识分享,早上 8 点,准时充电


产品经理的专属日历:
限2个月售卖,汇集产品、运营、原型等产品经知识,包含了300+哥知识点,30+老师分享产品方法论,累计耗时150天打磨。

建议产品经理人手一份!给团队买一份吧


12月1年90款APP打卡社群报名加入:
每天1元。一年365天,服务时间365天,所以加入越早越划算第二年续费打折,邀请朋友加入打折储值之外没有其它折扣。800+位一线产品经理,1000+篇主题200道精华覆盖产品原型、运营方法论、APP体验报告、少讲道理只讲如何提升。现在加入或续费知识星球,将会得到价值399元的《全行业APP体验报告拆解电子档》,包含了8大行业体验报告。

长按扫码
加入知识星球


老星友续费
长年 8 折

相关阅读

  • 一个亏钱的银行理财

  • 昨天写了一篇《固收类理财亏钱了,还被罚款》,文末问大家买过亏钱的银行理财没有,结果几个网友还给了亏钱银行理财的代码,博格专门研究了一下:这个招睿金葵18个月开13A,今年以来亏
  • 2022年度总结:年度最受欢迎作者之路

  • 关注并将「人人都是产品经理」设为星标每天早 07 : 45 按时送达2022年已经过去,新的一年即将开启。对于2022年,或许每个人都有很多感慨,在过去一年也成长了许多。作者选择用文
  • 职场人最爱的表情包,可能是它

  • 元旦小长假后的第一个工作周可终于结束了!相信屏幕前不少人在浪完3天后突然回归工作,都多多少少感觉有些“难顶”。这种时刻,大概也只有“痛苦面具”才能切实体现出职场人的心
  • 致B端PM:没想清楚发展赛道之前,我劝你先别跳槽!

  • 你现在的工作状态如何?是规划清晰,逐步进步中还是陷入了焦虑,不知道该如何改变现状?其实很多产品人,在入行B端一段时间后陷入瓶颈,焦虑但不知道如何破解:做了一段时间B端,做的都是一
  • 日辰股份交流

  • Q:2022年Q4的情况?对2023年的展望?A:2022年一季度偏正常,二、三季度疫情管控力度大,有一段时间要求外地到 上海后5天内不能在公共场所就餐,9月青岛即墨也有差不多一个月的全城静

热门文章

  • “复活”半年后 京东拍拍二手杀入公益事业

  • 京东拍拍二手“复活”半年后,杀入公益事业,试图让企业捐的赠品、家庭闲置品变成实实在在的“爱心”。 把“闲置品”变爱心 6月12日,“益心一益·守护梦想每一步”2018年四

最新文章

  • 产品经理【文档规范】基础要求总结丨建议收藏

  • 点击 ▲ PMTalk 关注,和 21万产品经理一起成长国内最会做产品、运营沙龙的产品经理社区正文共:3506 字 8 图 预计阅读时间:9 分钟全文概览01、文档的格式规范(字体、标题、图片