写给未来的你的文档:十分钟换18倍回报
写给未来的你的文档:我忘了自己的数据库结构,白白损失3小时;当初10分钟的文档就能避免。这个养成一次、受益终身的习惯,回报高达18倍,值得每个独立创业者坚持。
一个人做产品时,文档不是写给别人看的——它是写给未来的你的文档,而未来的你已经把一切忘光了。我在做一个功能时多花十分钟记笔记,本可以省下后来花三小时去逆向解读我自己数据库的时间。仅一个功能,回报就是18倍。
文档听起来是独立创业者所能养成的最“企业化”、最容易被跳过的习惯。事实恰恰相反:正是这个习惯,让一人公司能像团队一样运转——因为六个月前写代码的那个人,实际上就是另一个人。
我忘了自己数据库结构的那一天
三个月前,我为我的加速营平台构建了一个复杂的功能:多表数据库设计,结构缜密,带安全策略,一应俱全。设计和实现花了六个小时,我为此感到自豪。
后来我需要给这个功能加一个字段。我打开代码,看着那些表,开始阅读——却完全不明白当初为什么做出某些决定。为什么是四张关联表而不是两张?为什么这一列是可选的?为什么这条访问规则检查两件事而不是一件?
我花了三个小时逆向解读自己的代码。不是别人的,是我自己的。这个功能没有任何笔记,没有任何设计说明,没有任何东西能说明各部分之间的关系。只有代码,和一段悄悄把一切都删掉的记忆。
在团队里,决策会被讨论,知识会被共享。单干时,“为什么”只有一份副本——在你脑子里——而且它过期的速度比你想象的快。这就是单人开发的隐性成本,几乎没人把它算进去。
写给未来的你的文档:盈亏平衡账
做那个功能时花十分钟写文档,本可以在后来省下三小时。一个功能,18倍回报。现在放大来看:我有45个功能在线上运行。如果前期做好文档,每个功能长期下来大约能省两小时,那就是每年90小时——按每小时80欧元算,是7,200欧元的时间,而代价只是每个功能十分钟。
放到整个生命周期,账更加悬殊。以一个功能经历十次后续修改为例:
| 没有文档 | 有文档 | |
|---|---|---|
| 构建功能 | 2小时 | 2小时 |
| 写文档 | 0(跳过了) | 10分钟 |
| 之后每次修改 | 1–3小时重新摸索 | 10分钟阅读 |
| 十次修改合计 | 约22小时 | 约3.9小时 |
每个功能在整个生命周期里大约省下18小时。45个功能加起来,就是815小时——按每小时80欧元算,价值65,200欧元。但说实话,钱不是重点。重点是文档让你能做到什么:因为知道什么会出问题,所以能放心重构;因为记得自己的设计,所以能在过去的成果上继续构建;因为陷阱都写下来了,所以几分钟就能调试好。
本书The Solopreneur RevolutionLuis Gonçalves 讲述如何在不辞职的情况下用 AI 打造独立创业者事业。获取本书 →每个功能都需要的四份文档
做完45个功能后,我定下了四类文档,按重要性排序。
“为什么”文档——业务背景。最重要,也最常被跳过。这个功能解决什么问题、有什么影响、关键设计选择为什么这样做?这份文档能防止未来的你把一个有原因的决定“优化”掉。作为你产品的架构师,你的决策是唯一无法重新生成的资产——把它们写下来。
“是什么”文档——它如何运作。涉及哪些表、数据如何在功能中流动、事情按什么顺序发生。这份文档能让“为什么要四张关联表?”在三十秒内得到答案,而不是三小时。
“怎么用”文档——使用指南。你(或将来的客服人员)实际上如何操作这个功能:在哪里配置、用户会看到什么、步骤是什么。
“坑”文档——排障笔记。每一个咬过你的陷阱:看起来坏了其实只是慢的设置、某件事生效前必须存在的数据、你肯定还会再看到的那个错误的修复方法。每一条都能省下未来的一次调试。
让文档自动生成
坦白说,有一个反对意见:我连每个功能花十分钟手写文档都不愿意。它很无聊,而且这些时间本可以用来构建。在有AI之前,这个反对意见占了上风——每个功能的文档要花两到三小时,所以我跳过了。
有了AI,阻力就消失了。我构建的每个功能都从一份结构化的简报开始——一份PRP——里面已经包含目标、设计决策和注意事项。功能上线后,AI大约十分钟就能把这份简报变成文档。内容全面、风格一致,而且不会因为无聊而跳过章节。
然后用一条规则保持这个习惯:如果我发布代码时没有文档,就等于没发布。我的检查清单强制执行这一点——功能、测试、文档,三样齐全才能合并。我没法绕过自己定的规则,而这正是重点。
结果是:一千多页可搜索的文档,大部分由AI撰写,覆盖产品中的每一个功能。此后再没有出现过“我当时在想什么?”的时刻。等我雇第一位工程师时,他们第一天就能继承这一切——这是大多数单人构建的公司根本没有的两周入职先机。
12 周企业职业生涯从来都不是计划申请加入 Solopreneur Accelerator。立即申请 →常见问题
为什么要为只有我一个人做的项目写文档?
因为六个月后,你实际上就是另一个人了。我花了三小时逆向解读自己的数据库,只因为我什么都没记录。单人文档不是官僚主义——它是现在的你写给未来的你的一条信息,而未来的你读到时总是满怀感激。
我到底该记录什么?
每个功能四样:它为什么存在、关键决策为什么这样做;它在技术上做什么;怎么使用;以及咬过你的那些坑。如果只写一样,就写“为什么”——那是代码本身永远无法告诉你的部分。
用AI写文档要多久?
每个功能大约十分钟。如果你从结构化简报出发构建,AI就是用现成的材料生成文档——这是一次转换,而不是一个写作项目。过去的成本是每个功能两到三小时,所以没人去做。
单人创始人写文档的投资回报是多少?
我的数字:十分钟的文档对比三小时的重新摸索,仅一次修改就是18倍。放到一个功能的整个生命周期,大约省下18小时;我的45个功能加起来,约815小时——按每小时80欧元算是65,200欧元。再加上无法估价的部分:放心修改自己代码的底气。
你到底被困得有多深?
完成职场窒息指数——这项免费测评告诉你是否已准备好成为独立创业者。