一人工程 · solus opus

← 全部作品

一人工程docsoloknowledge

solo engineer 没有 doc,我想写就写

团队有 doc。

Wiki:每个项目一组页面;README:项目入口;onboarding docs:新成员上手;API docs:自动生成;architecture decision records(ADR):每个重要决定一篇文章;Confluence / Notion / GitBook / Docusaurus。

每个新成员读 2 周才能上手。

solo engineer 没有 doc。

我想写就写。

我的 commit message + 代码本身 + 我自己的记忆就是 doc。新成员?不需要新成员。我自己 6 个月后看代码看不懂?再看一次代码就行。

我没 wiki 的必要——访问者直接看主页。我没 README 的必要——访问者直接看散文。我没 onboarding docs 的必要——没有新成员。我没 ADR 的必要——决定都是我做的,commit message 描述清楚。

团队的 doc 价值是「知识共享 + onboarding」。前提是成员多、流动大、需要持久化知识。solo engineer 没这个问题——我的知识在我脑子里、我自己的 commit history、我自己的散文里。

一人工程的 doc = git log + 我的散文。不是 200 页 wiki。