0-50,000：我的团队如何在不到5个月的时间内编写出5万字的文档

人们对待文件的态度往往和对待保险一样。他们知道自己应该有文件，也明白拥有文件的好处，一旦出了问题就会后悔当初没有准备，但即便如此，他们还是没有行动。

我以前写过这个话题

为了便于理解，我目前是分析师团队的负责人，该团队负责处理公司内部提出的报告请求。

今年四月我接管团队时，几乎没有任何文档。我自己的入职培训也是几个月前的九月，当时只有几张PPT。工作的其他所有方面，我都是通过向同事请教和自己摸索才学会的。

这导致团队效率极低，每个员工都凭记忆各自为政，以自己的方式完成工作。与其说是一个团队，不如说是四个各自为政的人在做同一项任务。

当然，把责任完全归咎于我的前任并不公平，我至今还没见过哪个工作场所真正理解并愿意花时间做文档。我加入的团队总是忙得不可开交，即使他们想做文档，公司也不会给他们时间。

虽然团队缺乏文档，但现有分析师多年的经验弥补了这一点，因此团队受到的影响并没有人们想象的那么大。

然而，情况很快就发生了变化。2019年初，我们失去了一位经验丰富的员工，团队只剩下3名员工，而且5月底我们又将失去另一位员工。

基本上，我接手团队后，就得立刻失去那两位经验丰富的员工所提供的经验缓冲，他们原本可以弥补文档方面的不足。除此之外，我还需要招聘和培训两名新员工。

既然我不可能在他们开始之前凭空积累几年的经验，我就必须做点什么。所以，我没有让自己成为知识的孤岛，而是着手建立一套全面的文档。

值得一提的是，我曾担任过几年信息管理顾问。这意味着我对从哪里入手以及如何达成目标都有着清晰的认识。但我希望分享我的经验，因为优秀文档的秘诀并非藏在图书馆员把守的圣殿里。

第一步：列出需要记录的内容并制定计划。

从一开始就确定好文档的存储和访问方式至关重要。如果编写文档真的那么简单，人人都会这么做，世界就会被大量的“final-Final_1.docx”文件淹没。

在开始之前，您需要了解以下信息管理的关键规则：

• 信息必须存储在公司内任何人都能轻松访问的位置：C盘或电子邮件不是容易访问的地方，我的经验法则是：我的CEO能否随时访问这些信息？
• 信息必须能够自然地被发现。即使不使用搜索引擎，人们也能自然而然地找到这份文档吗？简而言之，它是否存储在大多数人理所当然会找到的地方？
• 信息必须具有自描述性。其名称或其上下文必须能够让读者快速了解文档内容。例如，如果某个文件位于名为“流程文档”的文件夹或部分中，则无需将其命名为“某某流程文档”，只需将其命名为“某某”即可。但仍然要使用描述性命名。
• 以上三条规则必须遵循KISS原则（Keep It Simple, Stupid）。复杂的文档结构最终会失效，并妨碍前两点的实现。不要过度设计，要习惯一些“这份文档无法归类”的棘手情况，接受这一点，一切都要着眼于大局。

牢记这些规则后，下一步就是构建文档地图。首先，列出你可能需要的所有文档。

列出清单后，开始将它们归类到几个主要类别中，每个类别最多六个。每个类别应该反映员工选择该类别的原因，而不是主题本身。

最后，你应该至少有两个分类。一个是“如何完成工作”的文档，另一个是“非工作相关的文档”。例如，如果你是一名开发人员，那么概述如何将代码提交到用户验收测试 (UAT) 环境的流程文档就属于前者，而关于如何申请病假的文档则属于后者。

我们队最终得了四个分数，分别是：

• 团队特定流程信息，即如何完成工作
• 支持性文件，例如我们的团队奖项提名页面。
• 主题信息，即关于公司主题的深入信息，将有助于完成工作。
• 技术信息，例如如何将文件上传到 S3 并复制到我们的 Redshift 环境。此外，这也逐渐变成了一个包罗万象的内容。

接下来要考虑的是，你的信息将存储在哪里。

把所有东西都放在一个地方存放可能很诱人，如果可以的话，你应该这样做，但这通常不是那么简单。

我的团队需要存储 SQL 脚本、工单信息、内部信息以及客户信息。最终的方案是，我们的代码存储在 Google 云端硬盘中，每个工单对应一个文件夹。工单的其他所有信息都存储在工单系统软件中。我们的内部信息存储在公司内网上，而客户需要阅读的内容则存储在大家都在使用的帮助中心。

在之前的岗位上，我们将流程存储在公司内部网，但主题信息存储在工单软件中，因为这有助于我们处理工单，而且我们的呼叫中心也可以访问这些信息。

然而，这种划分必须合乎逻辑，或者至少应该让所有人都清楚哪些部分应该放在哪里。不能出现任何矛盾之处。

所以，此时你应该已经有一个文档结构图，概述了你将如何组织信息以及信息将放在哪里。

第二步：确定优先事项

现在您知道如何存储信息了，接下来就需要执行，但通常所需的信息量之大令人望而生畏。就像任何项目一样，我建议您先确定优先级。所以，请回到您的文档结构图，并将其按以下方式分类：

• 昨天就需要了
• 急需
• 需要在未来6个月内完成
• 或者稍后再做。这应该有助于你决定按什么顺序去做。

对我以及我的团队来说，这是一项简单的任务，因为我知道六月份会有两名新员工入职，所以我的目标是完成所有必要的入职文件，并将其他所有事情都放在“以后再说”的清单上。

第三步：使其成为一个互动过程

我们成功的关键在于将文档编写视为一个迭代过程。

我一开始使用一套模板创建空白的内网页面，并标记出不完整的页面。接下来的几周，我们根据需要逐步完善每个页面。有些页面一直保持着简略的状态，直到我的新员工入职很久之后才有所改进，而他们中的一些人在学习的过程中也能够为这些页面做出贡献。

第四步：融入文化和工作流程

我们四人团队能在如此短的时间内完成 5 万字的写作，关键在于我们将其融入了我们的工作流程和企业文化。

每次处理完一个工单，他们都会先查阅我们的文档，看看我们之前是否写过相关的内容；每次处理完一个工单，我们都会把处理过程中学到的所有经验添加到文档中。我们还会把这些文档链接到相关的工单，方便以后查阅。我还安排了一些员工暂时放下处理工单的工作，去整理一些关键的文档。例如，我们数据库里有一个关键表，里面有超过50个类型代码，所以我安排了一位团队成员专门负责弄清楚这50个代码的含义。

通过在流程的两端都设置文档检查标记，团队可以立即感受到记录已知信息的价值。此外，我们还没有涵盖所有方面，所以当收到关于未记录领域的工单时，团队会深切感受到这种缺失带来的困扰，因为其他许多方面都已记录在案。这促使他们力求做到万无一失，不留任何空白。

第五步：安排时间

编写文档无疑是最难的一步，但它确实能为你节省日后的时间。我曾经在代码运行期间或项目间隙挤出时间来编写文档。有时我甚至会直接对客户撒谎，拖延交付日期，所以我格外珍惜编写文档的时间。

结论

建立文档体系的过程虽然艰辛，但并非难如登天。如今最艰难的时期已经过去，它带来的回报也显而易见。新员工比以往更快地融入团队，现有员工和公司其他部门的同事都感谢我们把那些原本只存在于大家脑海中的信息记录下来。现在一切都已成文，我们得以纠正一些前后矛盾之处，团队成员也养成了记录所学内容的习惯。

把所有事情都记录下来，打开了以前无法打开的大门。我们开始根据浏览量最高的文档编写模板代码。我们能够优化现有流程，并自动化一些关键的管理任务，这一切都是因为这些信息不再只存在于人们的脑海中。我也更有信心离开团队，因为我们所有的流程都已记录下来，如果他们需要根据经验做出决策，可以向团队其他成员寻求帮助。

就像保险一样，做好文件记录是有价值的。

我是谁？