站长评论失焦?技术文档人眼中的清醒观察
|
去年过年时,我在机房改完第三版《API网关鉴权配置白皮书》初稿,窗外雨下得像漏了的冷却液管——不是毛毛雨,是那种砸在防火板上噗噗响、节奏错乱的冷雨。空调外机嗡嗡震着,震得我左手边那杯冷透的豆浆表面泛细纹。王工突然推门进来,没换鞋,鞋底在防静电地板上拖出两道灰印,顺手把一盒没拆封的虾饺搁在我显示器右下角,盒子上印着“XX年腊月廿三赠”。他扒拉我键盘说:“快看站长新评论,刚冒出来的。” 我点开那个带小铃铛图标的通知——结果第一眼就卡在“文档结构建议”四个字上。他夸目录层级“符合认知直觉”,可我分明把“3.2.1 接口超时熔断策略”挪到“4.5 容错与降级”底下整整七天,只因测试组实测后说“83%的人查超时问题会先翻容错章节”。站长批注里一个字没提这个挪动,反而用红框标出原版第12页的“本文档适用对象:运维工程师/DevOps人员”,加批:“建议扩展至SRE及平台架构师”。我盯着那行字看了十八秒。不是不认同,是……它根本不是当前版本的问题。当前版本连SRE要查的Service Level Objective校验脚本都还没塞进去。他评的像是我三个月前交的草稿。 刘姐端着保温杯路过,杯口雾气直往上蹿,她歪头扫了一眼屏幕,说:“又在盯站长评论?”我没应声。她拧开杯盖吹了口气,茶渣在水里打了个旋儿。我把页面切到历史版本对比图,发现他点赞的那个“清晰易懂”的流程图,其实是V1.3版被我砍掉的旧设计——当时因为研发反馈“跟实际调用链不一致”才删的。我原以为他会揪住V2.7里新增的七个YAML字段注释缺失,结果他连字段名都没扫全。这哪是审文档,这是对着文档残影打靶。 更绝的是技术中台的李伟,穿件洗得发白的蓝工装,袖口蹭着两道焊锡灰。他昨儿蹲在IDC机柜旁核对物理拓扑,今早八点就坐我斜对面,一边嚼韭菜包子一边刷评论区。他指着站长那句“建议补充灰度发布协同机制”问我:“你补了吗?”我说补了,在附录D。他直接翻到PDF最后一页——没找见。我点开本地Markdown源文件,附录D明明挂着,但编译时被build脚本漏掉了,因为上回merge冲突时我把`appendix-d.md`的include路径写成`./appendix/d.md`,而文件实际在`./appendix/D.md`——Linux大小写敏感,Windows不报错。这事儿我自己都没发现,还是李伟今天晨会随口问起我才翻出来。站长却在那儿热情洋溢地肯定“协同机制描述完整”。完整个鬼。
文章配图,仅供参考 雨停了。隔壁配电室的UPS报警音突然拔高半度,持续六秒,然后归零。我听见自己后槽牙咬紧的声音。桌上的虾饺盒子还开着,里头最上面那只裂了缝,露出一点橙红色虾肉。站长不是瞎,是焦距调错了。他拿产品路线图的尺子量操作手册,拿用户体验报告的标准卡API错误码表,拿老板周报里的“提效30%”去比对某个字段是否写了默认值。这不是挑刺,是把CT片当X光片读——都叫影像,但拍的压根不是同一层组织。 但说实话,这失焦……挺好的。优胜劣汰。真的。上季度我们组三个新人,两个拼命补站长批注里的“行业最佳实践”——跑去学SRE白皮书写作框架,重画所有泳道图,给每条curl命令加英文术语括号;剩下一个,把站长夸过的那版旧流程图扒下来,贴到内网知识库,标题改成《为什么这个老图现在不能用》,下面列七条现网不匹配证据,每条都带抓包截图和commit hash。上周他转正答辩时,技术委员会没人提站长评论,倒围着那七条追问了四十分钟。我敢打包票:他明年肯定不干文档岗了,要去做混沌工程。 王工又进来了,这次拎着两罐冰啤酒,易拉罐上全是水珠。他放下一罐,拧开另一罐,泡沫溢到他虎口的老茧上。“你猜站长刚才电话里说什么?”他仰头灌了一大口,“他说下周要开‘文档价值共识会’。”我摸了摸那罐冰啤酒,罐身湿滑,指腹沾了水。他接了个电话,听筒声音漏出来半句:“对,就那个…让文档团队也带个优化方案…” 我忽然想起昨天凌晨三点,测试环境崩了,我爬起来改完`auth-config.yaml`示例,顺便把所有`#TODO: add RBAC matrix`注释删了——删之前截图存了本地,没提交。这事我说不准它算不算埋雷,反正截图文件名叫“2024-01-22_删注释留证.png”。 现在我盯着文档管理系统里那个绿勾——“最新版本已发布(含站长全部修改建议)”。可我知道,他标红的三处“需增强说明”,我一条没动。其中一条要求“解释JWT令牌轮换周期设定逻辑”,但真实逻辑是研发经理上周在食堂打饭时随口说“就按OAuth2.0 RFC 6749里72小时写的,别深究”。这话我没记入文档,但记在了钉钉私聊截图里。截图里还有段语音转文字,他说“真有人较劲,就让他去看RFC,咱不兜底”。这句话我也没写进文档。 刘姐的保温杯空了,她把杯底最后一滴茶水晃了晃,喝掉。杯底沉淀着几粒深褐色茶叶梗。她走时带上门,没关严,门缝里漏出走廊日光灯频闪的微光。我点开文档编辑器,把光标停在“3.2.1 接口超时熔断策略”标题前。删掉空行。加了个句号。又删掉。再加了个空格。就这。没别的动作。这事儿我明天早上九点前得干完,赶在晨会前。现在?先喝完这罐啤酒。罐底还剩两厘米,气泡浮上来,慢得像在等什么。 (编辑:站长网) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |



