转赞:技术文档里的荒诞,二十句可以当说说用

一、技术文档里有一种冷幽默

它不打算逗你,但因为太认真,反而好笑。

在 BackendWiki 或 万象云档 的文档里,我经常捡到这类句子。

二、四类真实的荒诞

一、过度的补充说明。

“注意:不要把服务器放在水里。”——这种不加会有人犯吗?会的。

二、自相矛盾的前提。

“本功能需要先启动服务(服务需先启动本功能)。”

三、语气的突然转变。

前面写了三页参数,最后一句“总之重启一下”。

四、极度乐观。

“一般不会出现问题。”——这句话本身就让人担心。

三、二十句从文档精神里长出来的句子

  1. 说明书说“简单三步”,我做了四十分钟。
  1. 教程第一步:确保环境正确。最后一步:如仍有问题,重新开始。
  1. 文档里有一行写着“此处不要修改”,我改了。
  1. 那句“重启一下试试”,救过我三次。
  1. 代码注释写着“临时方案”,日期是四年前。
  1. 需求文档说“简单调整”,改动了十一处。
  1. 我写了一上午的文档,最后一行是“仅供参考”。
  1. 说明书警告不要做某件事,我爸做过三次。
  1. 我们公司的规范第一条是“保持规范”。
  1. 这个系统的用户手册有 400 页,第一页写着“本系统很简单”。
  1. 会议纪要最后一行:待补充。
  1. 这行代码写着“不要删除”,没人知道为什么。
  1. 培训文档说“有问题请咨询”,但联系方式是空的。
  1. 版本说明写“优化体验”,我找不到哪里变了。
  1. 报错信息写着“失败”,就两个字。
  1. 我在文档里搜“为什么”,一条都没。
  1. 那个按钮旁边有个叹号,点一下写着“请小心”。
  1. 系统提示“操作成功”,但什么都没发生。
  1. 附表一共十七张,正文说“详见附表”。
  1. 我把文档打印出来,装了一整个文件夹。

四、一个提醒

不要拿具体公司和具体产品开玩笑。

把矛头指向“文档”这个文体,比指向具体产品安全。

五、一个方法

想找这类素材,就去翻没经过润色的官方文档。

越认真、越详细的地方,越好笑。