
开发者用AI写技术文档引争议:AI生成内容可读性差
来源标题:Technical Writing in the AI Era
开发者开始用AI撰写RFC、RCA等技术文档,但AI生成的内容篇幅冗长、术语堆砌、同一概念用词不一,人类难以阅读。作者认为AI适合做资料搜集,文档的可读性仍需由人来把控,因为写作时要设想读者是谁、具备怎样的技术背景与词汇量。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
在当今的AI时代,技术写作非常重要。我说的技术写作,是指RFC、RCA之类的技术文档。
开发者现在用AI写代码,但也开始用AI写文档了。
AI生成的代码没问题,因为机器会读代码,也能理解。但文档不一样,文档是给人读的。
我读不了AI写的文档,读起来非常费劲。它无缘无故就写得很长。AI喜欢堆砌术语,同一个东西在不同段落里用不同的词。
写文档的本质是跟同行和其他人沟通。
AI擅长做调研、为文档找素材,但让文档变得可读是人的工作。AI写出来的内容东一榔头西一棒子,它不了解读者,不知道读者会怎么读这份文档。读者的阅读是有流程的。
人写东西的时候,脑子里会有一个理想读者。这个读者可能是共事过的人、现实生活中认识的人,你了解对方的技术水平和词汇习惯。
AI出现之前就有一些自动生成的文档,现在我觉得它们很多余,比如API文档;大多数时候,它们不过是一张JSON字段名和字段类型的表格。如果源码是开源的,AI可以直接读源码,或者直接读OpenAPI spec就行了。
我认为,面向人类读者的技术文档还是应该由人来写,比如RFC、RCA等。这件事现在比以往任何时候都更重要。我们交付的代码比以往任何时候都多,也应该用高质量的文档让同行之间的沟通更高效。
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。