GREENROSE STORIES · VOL.1
文档里的绿玫瑰 · 技术写作者的回声
Sam被内推进大厂的时候,面试官问他"为什么想做技术文档",他回答得很真诚:"因为好的文档能让开发者少熬几个深夜。"面试官点了点头,在评分表上写了一个"pass"。
第三年的时候他不再说这句话了。不是因为不真诚,是因为他发现没有人真的在乎。
他写了一百四十三份API文档、七十八份架构说明、五十六份新人onboarding指南。阅读量最高的一篇只有四百次点击,评论区零星几条——"这个参数写错了""感谢,很有用""怎么没有Python版本的"。没有HR把他的文档放进晋升答辩。没有同事在周会上说"Sam这周更新的那篇部署指南帮了我们大忙"。他做的是一份"看不见的工作"——当文档写得足够好的时候,没有人会注意到它的存在;只有当它不存在的时候,世界才会报错。
第四年春天,一个后端工程师在群里说:"谁能帮我解释一下这个接口,我自己看文档看了半天没搞懂。"有人艾特Sam,Sam回了句"文档第24行有说明",然后附了个截图。对面沉默了几分钟,然后回了一句——"原来有文档,我一直没看。谢谢。"
Sam盯着屏幕,把那句"谢谢"读了三遍。这是他入职以来第一次被说"谢谢"。
夏天的时候,公司上线了一个新的微服务,架构复杂到连CTO画图都要提前列提纲。Sam花了三周写了一份完整的文档——不只是接口说明,还有设计决策的背景、已知的权衡取舍、未来可能的演进方向。发出去的当天他收到了十二封感谢邮件,其中有一封来自刘明——那个从不夸人的技术负责人。刘明在邮件里写了一句话:"这篇文档不像是写给代码的说明书,更像是写给下一个接手系统的人的一封信。"
Sam把刘明的邮件截了图。他没有发朋友圈,而是把它保存在一个叫"回声"的文件夹里。他忽然理解了:最好的文档不是被读到的,是被感受到的。是某个凌晨三点正在排查故障的工程师,在搜索引擎里输入了一个关键词,然后点开了他写的那一页——三分钟读完,困惑消散,那个工程师在心里说了一句"谢了"然后继续修复bug。
Sam在网上订了一个绿玫瑰的刺绣徽章,别在了工牌旁边。他想提醒自己:有些价值从来不会出现在仪表盘上。它只会在某个人的深夜,安静地发光。