初创公司如何抽时间编写软件文档

作为一家生产基于知识的软件的公司，我们天生就认同良好文档的价值。

然而，许许多多的初创公司几乎没有文档。这根本就不是优先事项。

任何初创公司都不容许任何浪费精力的行为，但我们每天都在重复信息和搜索对工作至关重要的信息上浪费大量精力。事实证明，起初看似高效的做法实际上严重阻碍了生产力。

这就像身处一个迷宫，相信有办法走到尽头，但实际上你置身于一个无尽的迷宫中，将永远迷失方向。

这就是没有适当文档的写照。没有合适的文档，初创公司就不可能规模化发展。那么，为什么公司都未能做好文档工作呢？

初创公司缺乏全面文档的原因

初创公司创始人在早期忽视文档的原因有很多。你可能身兼数职，凭感觉行事。以下是一些最常见的原因。

不重视文档

首先，公司缺乏文档的主要原因是他们不重视文档。相反，他们的重点放在似乎与产品更密切相关的部门，如工程、产品和销售。

事实上，文档可以帮助每个部门更有效地运作。

将文档与“瀑布式”开发方法关联起来

许多采用敏捷方法工作的初创公司认为文档是一种过时的软件开发方式。他们从字面上解读了敏捷开发的四大关键原则之一：可工作的软件胜过详尽的文档。他们认为这意味着只需要可工作的软件，而文档本质上被视为浪费时间。

这可以追溯到瀑布式软件开发的时代，当时团队需要生成大量文档，包括需求文档和设计文档。而敏捷文档只涵盖必要的内容。

缺乏投入文档的时间

有些初创公司确实重视文档，但总有更多的事情要做。编写文档意味着要从不断堆积的重要任务中抽出时间，即使从长远来看，文档能节省你的时间。

文档是关于未来的投资，而许多创始人只有时间考虑当下。

公司发展太快，来不及记录

为一个变化速度和你记录速度一样快的过程编写文档，似乎是在浪费时间。在一个需要快速成长和变化的公司里，记录流程也可能显得“不灵活”。

等到你写完文档时，你的团队可能已经向前迈进了。

试图避免过于“公司化”

做记录流程这样枯燥的事情，可能会让人觉得它正在扼杀你的文化。公司的文化很可能是自然生长起来的，并且是公司希望保持的东西。对于开放和包容的文化来说，标准化可能显得过于正式和压抑。

但是，建立“文档优先”的文化可以是有趣且进步的。文档意味着你推崇团队合作和开放的文化。

现在就开始您的 Baklib 14天免费试用吧

立即开始

在软件代码方面，许多开发者认为，如果代码写得好，就根本不需要任何文档。但代码注释（本身具有价值）与能告诉你更多关于软件信息的软件文档之间，存在着天壤之别。

有用的软件文档包括教程、安装说明和用户问题的解答。文档还应说明你为何构建该产品。

文档缺乏明确的负责人

公司都认同需要更多的文档，但却没有人被授权去实现这一点。有人建议你的支持团队应该"在空闲时间"完成，或者你可能会要求开发人员在编写代码后记录功能。

通常，你缺乏一个能够有效产出高质量文档以实现目标的过程。

为何应投资于优质文档

"成功扩展的标志是知道何时踩下刹车，以便未来能够更快地扩展。" – 斯坦福大学组织行为学专家 Bob Sutton

首先，大多数消费者一致认为，拥有高质量的产品内容对于以下方面至关重要：

• 良好的客户服务
• 使他们更容易自行解决问题
• 提升他们对产品或品牌的印象
• 使他们更有可能推荐产品或品牌
• 促使他们更有可能购买更多产品

以客户为中心的初创公司应该重视文档。而敏捷团队天生就是以客户为中心的。

以下是一些具体原因，说明文档对您的业务为何有价值。

文档为您省钱

文档是能够有效扩展业务的关键部分。一方面，它减少了您的支持团队必须处理的电话和电子邮件数量。一个支持电话可能花费高达11美元，而自助服务支持体验仅需几美分。

如果您能说服更多的软件客户使用自助服务，这意味着您可以雇用更少的支持代理来处理相同数量的客户。

文档改善客户教育

许多初创公司销售在其行业内具有创新性的产品，客户可能不习惯使用“更新”的模式来消费您的产品。

💛🧡🧡客户评价：我们一直在使用Baklib已经好几年了，它一直超出我们的预期。第一突出的功能是高水平的低代码模板定制，它允许您以您需要的方式构建文章，并提供广泛的站点发布满足不同需求的选项。该平台很直观，但是真正让它与众不同的是卓越的客户服务。他们的支持团队响应速度非常快，通常在几个小时，这对我们的团队来说非常宝贵。此外，频繁的产品更新可确保平台保持最新并与最新的行业需求。总的来说，Baklib一直是可靠且高效的满足我们知识管理需求的解决方案。它很容易集成，我们不需要对集成方面花费更多精力。我们的团队每天都使用它来管理文章。

例如，Netflix是视频流媒体的先驱，当时许多客户习惯于从实体店租借DVD（哦，嘿，百视达）甚至是录像带。他们无法理解像Netflix这样的服务有何价值。

许多客户不会立即理解新的流媒体模式以及为什么他们应该继续支付月订阅费。文档可以帮助教育新客户并解释产品的工作原理。

文档是对客户的投资

许多初创公司高度专注于吸引新客户使用其产品。根据定义，它们正在打入新市场。

与更成熟的公司和品牌不同，初创公司需要改进为客户提供的服务。研究表明，69%的客户认为清晰的说明表明公司关心他们以及他们使用产品的能力。

文档是提升消费者信任的强大方式。文档也可以是关于与您的社区互动和投资于现有客户的。

文档改善运营

标准操作程序对于快速发展的初创公司也很重要。在内部制作信息丰富的文档可以让您更有效地进行授权，并避免依赖“把关人”来传播关键知识的陷阱。

SOP 使您的更多假设变得明确，从而使您可以更轻松地决定改进做事的方式。它能更清楚地表明，您一直以来做事的方式已经变得……嗯，有些疯狂！

文档改善新员工入职

拥有全面的内部文档可以缩短入职流程，减少面对面培训的需求。新员工可以根据需要查阅员工手册，而不必害怕提出“愚蠢”的问题。

手册可以传达您公司文化的重要组成部分，每个人都有一个可供参考的资源。像 GitLab 这样的公司已经公开了他们的手册来帮助他人。

如何更有效地确定文档的优先级

除非您在公司的各个层面都灌输对文档价值的认同，否则无法提高文档在您公司中的地位。员工需要感到有权从其他任务中抽出时间来撰写文档，否则他们必须雇用专门的文档编写人员。

现在就开始您的 Baklib 14 天免费试用

1. 评估公司现状

您所需的文档数量应与公司所处的发展阶段相匹配。

一家仅有几名员工的全新公司并不需要海量文档。另一方面，当您的团队开始扩张，并可能招聘许多远程团队成员时，以更正式的方式开始沉淀公司知识就显得尤为重要。

2. 明确所需文档类型

您需要花时间明确您需要哪些类型的文档以及原因。并非所有文档都相同。

区分内部文档（有助于您标准化流程）、旨在简化开发人员工作的软件和开发文档，以及面向客户的产品文档非常重要。

您需要不同类型的撰稿人来制作每种类型的文档。

3. 投资最重要的内容

我们认为最终用户文档应始终被视为最终可交付产品的重要组成部分。因此，这是最值得投资的文档类型。

可运行的软件和客户文档都是您最小可行产品的一部分。最终用户文档可以由支持人员、专职技术撰稿人或公司内的每个人来制作。

4. 众包您的内容

在公司发展的早期阶段，通过类似维基的方式制作内容可能很有用，正如Splunk在他们的书《产品即文档》中所谈到的那样。

Splunk 发现，当公司规模较小时，实际上有更多人为维基内容做出贡献，而在文档团队规模扩大后，这种情况反而减少了。如今，Splunk 拥有一个20多人的文档团队，但公司内部几乎不再有其他人为维基贡献内容。

在公司早期，角色流动性更大，更容易说服团队参与文档编写工作。

5. 在敏捷开发中编写文档

对文档工作采取准时制方法。

与其记录所有内容，不如识别哪些支持对话可以转化为帮助文章，并根据需要进行记录。如果您担心文档不够全面，请记住，知识库中排名前5的文章占每日总浏览量的40%。

客户文档与敏捷方法论高度兼容，因为它以客户为先。您拥有的任何技术作者都应该是Scrum团队的一部分。您提出的任何文档任务都应该与代码一样，记录在同一个问题跟踪软件中。

6. 采用 Docs Like Code 方法

软件文档最好使用与代码相同的工具和方法来制作。如果您是为工程师受众编写代码文档，最好对文档和代码使用相同的工具。

使用 JIRA 或 Git 等工具进行文档管理也意味着可能更容易获得团队中工程师的内容审阅。他们可以在自己熟悉的工具中更轻松地分享反馈。

7. 向工程师展示文档的价值

当您的工程师通过经验了解到文档的价值时，他们会更有动力为文档做出贡献。文档流程可以充当质量保证的角色，在产品发布到市场之前揭示潜在的缺陷。

对于首次学习该软件的开发人员，甚至是对于那些要回头处理“很久以前”完成的工作的工程师来说，API 和其他软件文档都极具价值。

8. 聘请技术文档工程师

一些快速发展的初创公司没有足够的资金来投资聘请专职技术文档工程师。随着团队需求的变化，预算分配可能会波动，对文档的需求也可能随之增减。

聘请自由职业的技术文档工程师可能是一个很好的折中方案。许多初创公司选择与经验丰富的专业人士签订合同，来完成特定的文档项目，而无需承诺雇佣另一名全职员工。

同时阅读： 顶尖的软件文档工具

总结

关键不在于产出大量的文档，而在于识别出你真正需要的文档类型。更多的文档不一定与敏捷开发相冲突。文档对于真正敏捷的团队至关重要。

当一家初创公司重视文档时，它就是在重视其员工和客户。花时间进行文档记录，意味着你的公司能够更有效地扩展。