五千字总结【文档规范】的基础要求

​五千字总结【文档规范】的基础要求文档是我们工作中最基础的一部分，但是这些产出物真的合格吗？如果我们想提升文档能力，可以采用哪些“拿来即用”的简单方法？本文分享了一些基础的规范和注意事项，希望能对你有点帮助。“故不积跬步，无以至千里”，成长如此，文档亦是如此。当我们把一个个小细节处理好之后，最终呈现的效果一定会不一样。早在今年七月份，就想给同事培训一下关于写文档中需要注意的基础要求、基础规范。但是因为种种原因一直拖延到现在，我决定把这些内容整理成文字分享出来，希望每位同行都能够重视文档的基本规范，不要因为一时的疏忽而造成不必要的负面影响。文档本身是产品经理日常工作中最基础的一部分，我们几乎每天都在写文档，但是这些产出物真的合格吗？如果我们想提升文档能力，可以采用哪些“拿来即用”的简单方法？今天我便以自己这些年在写文档中（以word为主）踩过的坑，以及在工作中总结出的技巧逐一介绍。全文概览：明确文档的重要性文档的格式规范（字体、标题、图片、目录）文档的内容规范（错别字、书面语、文件名）其他需要注意的细节（6条）最后的总结文章不短，可以先收藏哈~01首先，要明确文档的重要性提升意识，是做好一件事的前提条件。我发现很多文档写的不合格，甚至比较烂的同学，在重视程度上就很差。所以最近两年我在新同事入职培训过程中，第一要务就是提高大家对文档产出的重要意识，并通过前期工作的仔细检查筛选出常见错误，后期自己再写的时候才能真的注意这些问题。幸运的是通过一年多的努力，还是有所成效。对于我们日常产出的文档来说，无论是需求说明书、产品手册、产品介绍、甚至于一个普通的word汇报材料，或者项目进程中、验收过程中的各项产出物，或者售前过程中的诸多物料，都能客观反映出一个人、一个团队、甚至于一家公司的专业性。早在几年前，我就因为文档中的错别字导致团队错失关键机会；还遇到过因为错别字在申请专利时被专利局退稿；曾因为合作机构所提供的文档经常含有错别字而建议公司更换合作方；也经常遇到在工作中提交的文档被客户一顿嫌弃，打回重写等情况。所以，如果我们真的只把这些文档当做团队内部的“应付材料”，或者觉得反正这么多字，也没人细看而长期没有形成好的规范习惯，那后续会踩到的坑一定不会比我少。因此，我简单总结四点文档规范的重要性供大家参考，希望能引起我们真正的重视：体现个人、团队、公司的专业性，能够得到对方的认可，同时不要因为这些“所谓的小事”被别人挑毛病好的文档能够提升“可读性”和“易读性”，对阅读者产生良好印象的同时，也能尽量避免错误理解，在后续的工作推进中产生不必要的麻烦作为客观的可参照物，真正在双方扯皮时，文档是最有利的佐证。而一旦文档中出现模棱两可，或者对自身团队不利的内容，前期如果没发现，后期会不会挖坑那就只能自求多福了。最后则是我上文中提到的一些关键性问题，一旦这些材料用于一些重要途径，便很容易产生重大的负面影响。明确重要性之后，我们便可以正式介绍今天的主题：基础规范要求因为不同的行业，不同的团队，不同文档用途，其中的内容、格式、结构等等都会有非常大的差异。所以本文不会在这些“变量”中过多介绍，而是从各类文档都要遵循的基础规范来进行说明。02文档的格式规范这方面大多数产品同行应该都会注意，但很多时候文档写多了，我们也会变得“麻木”而忽略一些细节。而其他岗位的同事很多就不太注意文档格式的规范性，最终的交付物让人“一言难尽”。格式规范性主要包含字体、段落标题、段内标题、图片、目录这几类内容。1.字体问题字体最关键是需要全文统一，我们可以按“正文字体”、“小标题字体”、“表格内字体”、“补充说明字体”、“重点突出字体”来分类，并保证每个类别的全文字体一致。表格内的字体还要考虑字体大小是否会让表格排序“失真”或“凌乱”，表格的首行标题建议加粗、居中。章节的各级标题一定要使用格式刷来统一维护。很多文档不同的段落字体大小、样式都会有些偏差，究其原因还是作者没有检查的意识，也没有在完成复制粘贴后顺手用格式刷统一的习惯。2.标题编号问题各级标题在用格式刷统一的过程中，非常容易出现一些小错误。比如级别错误，下图便是将四级标题，误刷成三级标题。比如没有重新开始编号，下图显然是将规则复制粘贴过来之后，没有重新编号。一个文档中段落内的小标题也尽量采用一种格式，比如选择使用（1）（2）（3），就不要再使用①②③，除非在文档中有多处不同级别的排序需求再考虑多种小标题样式。3.图片格式问题文档中的图片要居中，如果某个章节有多张图片连续，则需要给每个图片附上文字说明。而且图片的大小也需要微调，尤其是一些图片复制进去之后很大、很模糊，此时把图片缩小成尽量全文统一的大小则显得很有必要。尤其是一些移动端截图，复制到文档之后可能会“又细又长”，这时我们一定要随手调整大小。4.文档的目录问题目录记得及时更新，我们经常遇到内容修改之后没有更新目录直接提交的情况。也要记得把目录的字体、间距调整到适当，因为很多默认的目录格式说实话，挺丑的。以上这些细节，都是文档的格式规范要求，每一条单独来看可能都知道要这样做，或者也很简单觉得可以做到，但当这些问题汇集到同一个文档时，就是“阅读者的灾难伊始”。03文档的内容规范性关于文档的内容，因为不同的行业和用途有不同的内容要求，本文侧重点不在于内容如何整理，而是无论哪种内容，我们都需要检查、规避的常见问题。首先，也是我认为最最重要的一点：错别字在智能输入法普及的今天，我们日常的文字交流中充满了错别字，而这些错别字一旦在产品工作者的产出物中出现，会非常影响“印象分”，同时也会被质疑此人的细心、认真程度。大家也都知道出现错别字不好，但苦于难以察觉，但这并不是我们任由错别字存在的理由。所以对于错别字，我有以下几点建议：1）换一个相对智能的输入法毕竟一个好的输入法能够记住我们常用的专业术语，能够在拼写错误时给出智能提示，操作系统默认的输入法很难达到这个效果。我曾经发现一位经常打错别字的小伙伴，就是一直在使用mac的默认输入法，换了搜狗之后能降低大约60%的错字情况。错别字很烦银，比如当你读到这段话的时候，能否一言就看出短短几十个字里饱含着多少问题呢？我在看新同事写的文档时，关注的第一要素就是有么有矬子和语句不通顺的标大。2）在日常生活中多注意平时打字聊天的时候就养成不打错字的习惯，发出去的内容自己再扫一眼，如果出现了错别字及时改正，我认为这是一件很基础的事情。但是很多人都不在意，甚至被人多次指出之后也只是呵呵一笑，找个宽慰自己的理由，这些人一定写不出合格的产品文档。3）团队内可采取一些奖惩措施比如在关键文档中出现错别字之后，在团队内部发红包，或者当你看到其他同学的文档有错别字时及时提醒。总之一定要采取一些措施，让大家重视起来，养成日常检查的习惯，渐渐地错别字一定会越来越少。4）自己一定要通读几遍一个大段落写完之后，一定要重新读至少一遍，一方面检查错别字，另一方面检查是否存在语义表达等问题。自己要对自己的成果负责。5）可以让同事帮忙检查有时很难发现自我产生的错误，因为会陷入惯性思维怪圈。因此找同事帮忙检查也是不错的方式。而且相互帮助，去识别对方的错误，也能在很大程度上检视自己，提升错字意识。以上这些方法都可以快速运用，几乎“0门槛”，逐渐我们会提升错别字的敏感程度，快速识别错误，并且能够总结出一些“高频错字”。多管齐下，立竿见影。其次，在内容规范性上，还有一点很重要：书面语的表达虽然经过几百年的发展，文字表达从最初的文言文变成了白话文，但白话文也不代表等同于口语化。我也见到过一些同行在吐槽文档中为什么一定要用书面语，既费时又费力。而我个人认为原因在于这八个字：正式、规范、严肃、严谨。其实如果是团队内部的文档，只要领导没意见，你们愿意怎么搞就怎么搞。一旦涉及到对外输出，逻辑严谨、表达清晰、结构明确的内容便是基础。在此我列举几个关键点，建议大家在写文档时尽量规避这些问题。1）表达简洁易懂当然，可能有些文档就是需要复杂严谨（比如专利申请文档），读起来非常拗口但确实挑不出逻辑漏洞。不过我们大部分接触的文档，还是尽量简单、易懂，从而让读者尽快理解你想表达的意思比如：善于使用逻辑连接词：“因此”“进而”“所以”“反而”“除非”；简化短语，将“什么什么的时候”改为“什么什么时”；复杂逻辑采用分段、编号、配图等方式更直接地展现。2）避免歧义用词“一千个人心中有一千个哈姆雷特”，很多词语都有多面性，当使用不恰当时，非常容易造成读者的歧义。所以我们在使用这些词语时，要脱离自己的惯性思维，以用户视角来审视这段话是否准确。比如“XX等功能”，这个等字就很微妙。如果是售前类的文档，“等”没问题。如果是交付类的文档，“等”就很容易给后续的验收挖坑；比如“单位”这个词，既可代表计量单位，又能代表公司、用工单位。当然结合文档的上下语境能够体会出其中的含义，但在一段文字内，如果出现同一个词代表不同含义的，一定要加以说明，或者换一种表达形式。我还在一本书中发现“资产管理”这个名词很有歧义。大多数人会认为是办公资产、固定资产之类的“资产”管理系统，而作为金融从业者，第一反应会是“资金类的金融资产”管理系统，这两种系统完全不同。所以避免内容的“二义性”是内容规范中非常重要的一点。3）语义要直接，别让对方反复理解这里和表达简洁易懂有几分类似，但第一条更倾向于别说废话，此条更倾向于业务逻辑尽量直接。比如：把双重否定词（不得不）改为肯定（就）；把“穷举”改成“除了”（在条件1、2、3、4、5、6、7、8的情况下，改成除了条件9、10的情况）最后，关于内容规范性需要强调的是：文件命名规范文件名一定不能随便起，尤其是要发给客户的文档。最好能够通过文件名能让读者明白此文档的目的或核心内容。而且文件名最好能够和正文内的大标题保持一致，尽量在文件名中包含客户的简称、版本号、或者修改日期，其中修改日期一般出现在后续版本修改之后再添加。比如：【公司简称】产品名称+用途+版本号【客户名称】+公司简称+产品名称+用途+版本号产品名称+用途+日期-备注……总之，不要忽略文档名称的重要性，如果起一个不专业的名字，可能对方都不会打开看就驳回了。以上便是我对于“内容规范性”的总结，希望我们能给勤加练习，多多注意。04其他的注意事项还有一些其他的注意事项，简单整理供大家参考：1、我们在写文档时，有些没写完的内容会习惯性标注出来，等到后续再完善，但此时的标注一定要很方便的让你快速找到。比如采用特定的关键词（todo、待完善），或者插入批注。不要仅仅增加一个字体颜色或者背景色来标注。因为文档如果很长、如果没有逐行检查，很有可能会遗漏。2、文档内容如果不是特别多，在多人协作时尽量使用【修订模式】，避免协作过程中出现冲突或疏忽而产生内容问题。最终合并时再把修订内容逐一核对，可以避免很多协同过程的麻烦。当然，如果文档较长，修订模式会很卡，多人协作要么采用一些其他协同工具，要么做好分工，避免同一部分多人修改的情况。3、较长的文档，建议增加页码。4、最好有“版本修订记录”，但不是必须。毕竟修改记录后期维护起来非常繁琐。如果文档版本变动频繁或者有追溯的必要性时，再增加修订记录也可以。关于修订记录还需要注意一点：修订的内容是否适合让接收人看到？至于为什么，你可以细品一下，我就不多说了5、从其他文档复制进来的内容，一定要进行关键词检索。可以日常维护一个“关键词词库”，包含其他客户的名称、其他产品的名称、以及易错的关键词。待文档完成后，进行全局检索，大概率会有“惊喜”。6、客户给的模板，尽量不要在结构上大改。有些章节如果没有内容，或者不知道怎么写，可以标注“不适用”。但是如果你直接把章节删掉，后续交付、审核时可能会被纠错。当然，删掉的前提也要和客户沟通清楚。以上，就是今天所有的分享，不知道你看完之后有没有发现自己之前的小问题呢？如果有，那就快去改吧。如果没