你的技术文档被跳过了——不是因为用户懒,是因为你写得太"高级"了。
Flesch-Kincaid可读性测试有个反直觉的发现:高级工程师读8年级水平的文档,速度比读14年级水平的更快。不是因为他们看不懂复杂的句子,是大脑处理"认知负荷"的方式决定了:短句+常用词=更少摩擦。
企业文档平均落在14-16年级水平。这相当于要求读者拿着大学课本查API。结果?用户直接Ctrl+F搜关键词,找不到就关掉页面。
13岁能读懂的文档,40岁工程师更爱看
Flesch-Kincaid Grade Level 8是什么意思?美国八年级学生——大约13岁——能流畅阅读的文字难度。这个指标不看内容深浅,只看句子结构和词汇频率。
技术写作圈有个长期误解:专业内容必须用专业句式。长从句、被动语态、嵌套修饰,看起来"正式"。但可读性研究的数据很一致:句子超过25个词,理解准确率断崖下跌。
「Even senior engineers read faster at grade 8」——这句话本身就在示范。主谓宾,12个词,没有从句。你扫一眼就懂,不用回读。
对比典型企业文档的写法:"The implementation of this functionality is contingent upon the successful configuration of the prerequisite dependencies as outlined in the subsequent sections." 34个词,三层嵌套,被动语态。你的大脑需要拆解结构、还原主语、猜测指代。这不是阅读,是解码。
为什么聪明人反而需要"简单"文字
认知负荷理论解释了这里的悖论。工作记忆容量是固定的,不管读者智商多高。复杂句式消耗的处理资源,直接从"理解内容"挪用到了"解析语法"。
高级工程师的日常:同时开着IDE、日志、Slack、五个浏览器标签。他们读文档是任务驱动,不是休闲阅读。每多一层解码成本,放弃概率指数上升。
Google的开发者文档风格指南明确把FK Grade 8列为目标。不是低估读者,是尊重注意力经济。你写的不是论文,是工具说明书。用户要的是"怎么解决",不是"你怎么想的"。
有个测试方法:把你的文档贴进TextAnalytics API,一秒出FK分数。超过10?删掉30%的从句。超过12?把被动语态改主动。超过14?重写。
从14年级降到8年级的具体操作
不是让你写"参见图1",是调整信息密度分布。
第一步,句长控制。目标平均15词,硬上限25词。把"鉴于上述配置已完成,用户可继续执行下一步操作"拆成两句:"配置已完成。点击下一步继续。"
第二步,动词优先。被动语态隐藏主语,增加猜测成本。"错误被抛出"→"系统抛出错误"。谁做的?一目了然。
第三步,术语分层。首次出现全称+缩写,后续固定用缩写。但别在同一句里堆三个缩写。FK算法惩罚低频词汇,而技术缩写对算法来说就是低频词。
第四步,段落长度。手机屏幕上一屏2-4句话。超过就拆。视觉留白给大脑喘息空间。
最后一步,朗读测试。读出声,卡壳的地方就是用户会困惑的地方。
一个API调用就能测出你的文档有多"拒人"
TextAnalytics API(RapidAPI上架)提供FK等级+四种可读性评分。输入文本,返回数字。没有主观判断,只有算法打分。
这个工具的设计者显然吃过文档的苦。模板功能支持FAQ快速回复、代码片段复用——都是技术写作者的高频场景。
但工具只是镜子。照出问题是第一步,改不改是组织选择。我见过团队把FK 16的文档扔给用户,然后抱怨"没人看帮助中心"。
也见过反例。某云厂商把API文档从Grade 14改到Grade 7,支持工单量下降23%。不是内容变少了,是用户第一次就能看懂。
技术传播的终极悖论:你写得越"聪明",显得用户越"笨";你写得越"朴素",用户越能发挥聪明。
你的文档现在FK几分?测完回来聊——如果测完你还想聊的话。
热门跟贴