文档的惊人力量
输入“/”快速插入
文档的惊人力量
飞书用户1763
2023年11月16日创建
原文:
The Surprising Power of Documentation
说明:本文由翻译软件加人工校对生成,仅供学习。更多好文分享可关注「
涛然自得周刊
」
我是一个文档的忠实粉丝。在编码之后写文档是我最喜欢的无聊事情。它为企业带来了如此多的长期价值,以至于任何人投入到文档编写中的每个小时都能在整个公司节省100倍的生产力。
如果你是一名首席技术官(CTO),文档就是你的秘密武器,是你的创业公司中默默无闻的英雄,是在产品开发背后推动事情发展的灰色骑士。它消除了猜测和重复造轮子的问题。把它看作是你快速入职的黄金通行证。这张宝藏地图将引导新人和其他部门的老手进入你创业公司流程的迷宫。你的团队会更快地找到立足之地,成为更早有效的贡献者,并且比你预期的更有效地工作,这都是因为你决定优先记录下来。
不要这样
这里有一个问题,哪个更好:
1.
给某人写封电子邮件,打断他们的专注状态,要求解释一款软件的工作原理
2.
或者自己查找必要的信息,并以自己的节奏进行处理。
提示一下:第二个。
文档的重要性
让我们从基础开始。
想象一下,你是一家初创公司的技术合伙人(或者说你甚至不需要想象),你正陷入混乱之中,这是可以预料的。你每天都在应付各种问题,只是试图在被拉入另一个问题之前稍微喘口气。你如何摆脱这个恶性循环?答案很简单——文档化。现在,我不仅仅是在谈论维护一个简单的操作手册或记录会议纪要;这些也很重要,是的,但我指的是
建立一种知识不仅仅局限于个人,而是分散并对整个组织可访问的文化
。
每一件没有记录下来的事情都等于未来的资源浪费和潜在的烦恼
。你的烦恼。我不知道你怎么想,但我希望确保自己没有任何烦恼;这就是为什么我喜欢建立可以自动运行的系统。现在想象一下,你还没有记录下来的东西有多少,这就是你目前可能陷入意外问题的潜力。例如,由于一些软件包的更新,你的持续部署出现了问题。巧合的是,只有X部门的鲍勃知道如何解决这个问题。哦,而且他整个星期都在度假。
📋
文档可以减少麻烦,并让你安心度假。
您可以将文档视为有效知识共享的基础。在初创阶段,当您是唯一的编码和构建人员时,分享信息和见解可以简单地通过与CEO在办公桌对面交谈来实现。您拥有知识和手段来修复任何问题。但这是令人精疲力尽的,而且您基本上是公司的限制因素。如果您休假——不,您不会休假,因为如果您休假,一切都会停止。
随着创业公司的规模扩大,人数、项目和复杂性呈指数增长。知识被困在你的脑海中,沟通变得复杂,不知不觉中,人们花费更多时间来寻找信息,而不是真正使用它。
如果你是技术创始人,尽量提取你所拥有的每一点知识,并将其写下来。
这将成为一个普遍的真理来源,一个捕捉和保留集体智慧的动态知识库。这些智慧可以帮助团队中的每个人解决他们一分钟前还不知道如何解决的问题。这也将使你能够度假。相信我,你需要这样做。