我们最喜欢的轶事之一说明了让人们阅读这些文档有多难,它来自一个意想不到的来源:范·海伦(Van Halen)。
这支摇滚乐队因在演唱会上对后台设置提出异想天开和奇怪的具体要求而臭名昭著。乐队的标准合同长达53页,包括从“酸奶油鲱鱼”到“一大管肯德基果冻”的各种要求。但在“麦奇饼”部分,我们发现了臭名昭著的“M&Amp;Ms条款”--警告:绝对不能买棕色的。
因此,每个地点都会有一位幸运的人被派去把棕色的M&Amp;Ms从黄色、绿色和橙色的同行中拿出来。请记住,这是在20世纪80年代,所以当时实际上有两种深浅不一的棕色M&;M&M;M&;Ms,标准棕色和棕褐色,最终被淘汰,取而代之的是蓝色。
如果在后台发现任何棕色M&;Ms,乐队可能会取消整场演唱会,费用由赞助商承担全部费用。
事实,就像它经常发生的那样,要务实得多。乐队预料到没有人会阅读合同,于是设计了一个简单的测试,以确保他们所有的技术规范都被彻底阅读并遵守到T级。
范海伦的主唱大卫·李·罗斯(David Lee Roth)说:“范海伦是第一个在全国范围内使用850盏标准杆灯--巨型灯光的人。”“当时,这是有史以来最大的一部作品。”如果没有具体的指导方针,地板可能会弯曲倒塌,横梁可能会断裂,乐队、他们的工作人员和歌迷的生命可能会处于严重危险之中。
因此,如果棕色M&Amp;Ms在后台的糖果碗里,范海伦猜测,表演中更重要的方面-灯光、舞台、安全、票务-可能也是由粗心大意的推广者搞砸的。
“我来到后台。我找到了一些棕色的M&Amp;Ms,我走进了莎士比亚式的“这是我面前是什么!”……。你知道,一只手拿着头骨...。并迅速捣毁了更衣室。扔掉自助餐,在门上踢了个洞,价值一万两千美元的乐趣。
舞台在他们的地板上下沉。他们没有费心去看重量要求或其他任何东西,这导致他们的新地板下沉,对竞技场的地板造成了价值8万美元的损失。整个东西都得换掉。据媒体报道,我发现了棕色的M&Amp;Ms,并对后台区域造成了价值8.5万美元的破坏。
无论是合同、应用程序的服务条款、设计文档,还是您公司内部的维基,文档都很少能从目标受众那里得到彻底的通读。敏捷文档的TAGRI原则--“他们是不会读的”--不仅适用于软件开发,而且适用于所有类型的内部文档。
如果没有人会阅读您的设计文档或维基条目,为什么要浪费时间编写和维护它们呢?这经常会导致恶性循环:作家们觉得不值得花时间来正确地记录东西,因为反正没人会去读它,而且读者从来不会费心去阅读文档,因为它总是不完整或质量不高。
没有文献,所有的知识都是通过口头传授的。在一定程度上,当你的团队位于同一地点,而且规模很小时,它可能会奏效-也就是说,除非有人被公交车撞了。
但一旦事情开始扩大,问题就会出现。新员工加入,改变项目,调动团队,生病,度假,离开公司。他们随身携带着他们的知识-知识有时是在多年学习贵公司技术堆栈、内部流程和诀窍的错综复杂的过程中积累起来的。其结果是,新员工培训花费的时间更长,错误不断出现,生产率没有提高。
是的,人们不看文档。但这并不意味着它们根本就不应该写--相反,它们应该是为不读书的人设计的。
大多数人不会把你的文档从头到尾看完,不管它有多完美。不是因为他们懒惰,而是因为他们太忙了。正确阅读文档可能需要几个小时,而且大多数人没有那么多空闲时间。
事实是,最好的文档并不是用来阅读的。事实上,试图编写文档并期望其被读取往往是首先注定要失败的。
人们实际做的是查阅文档,这通常发生在另一个活动的上下文中。事实是,他们参考它,这就是创建它和做好它的充分理由。
您的团队与内部文档交互的方式对他们的工作效率有很大影响:
每当他们有问题并停下来在你的维基里查找一些东西时,他们的工作效率就会暂停。
如果他们找不到需要的东西,他们要么放弃这项任务,要么不得不发明一个新的方法来解决它,导致即使他们确实重返工作岗位,他们的生产率也会大幅下降。
文档的目标是使您的团队能够在他们需要的时候尽可能短的时间内找到他们需要的信息。这是为了帮助他们工作,然后不妨碍他们。这很少意味着要从头到尾阅读任何东西。因此,与其试图约束您的团队或欺骗他们阅读所有内容,我们需要训练自己设计、编写和组织我们的文档,以便有效地进行咨询。
当您使用单一来源的信息时,您会努力将其记录在一个地方,并且只记录在一个地方。不要指望人们愿意浪费时间在过时或重复的融合页面、随机的Google Drive文件夹或陈旧的电子邮件中寻找。使他们能够轻松快捷地查找信息--只有当所有答案都集中在一个地方时,才能实现这一点。
与流行的关于敏捷文档的误解相反,它并不是不存在的。它只是得到了有效的处理,在实践中,这确实证明了比传统主义者写的要少得多的文件。
不要仅仅为了拥有全面的文档而记录文档。写下你需要的东西,并且只写你需要的东西,心中要有明确的目的和受众。坚持一致的内容结构,指定一名“维基园丁”来修剪和编辑文档,保持维基的轻量级和可管理性。
如果没有人能找到伟大的内容,那么它就毫无用处。您的大多数读者不会滚动您的目录或您提供的任何其他导航工具-他们将使用搜索功能来查找他们要查找的内容。
无论您选择何种内部维基或文档工具来组织信息,快速可靠的搜索都是您需要的最重要的功能。当您有数千个文档时,您最不想要的就是手动滚动浏览它们,或者等待2分钟的搜索才能得到结果。您的内容还需要设计为可被发现,这意味着包括相关的关键字变体以匹配常见查询。
你越容易让人们找到他们需要的东西,他们就越有可能定期咨询医生。
我们没有耐心,注意力持续时间比金鱼短。为了被适当地吸收,信息需要以一种适应这一点的方式组织起来。
避免涉及广泛主题的长而多页的文档,保持文档简短而具体。提供足够的上下文,并使用内部链接来引导想要了解更多内容的读者。
使用“Brown M&;M”测试,并将隐藏的清单隐藏在你的文档中,可以帮助你当场抓住懒惰的读者,但如果你写文档的方式适应了不愿阅读的人性,那么你的努力将会有更好的回报。