众所周知,现在的 AI 可谓是十分甚至有百分的强大,吉米 K3、被 A\ Ban 完了的 Fable 5 和 Tibo 爷爷日常重置额度让你猝不及防的 5.6 Sol 打的有来有回,GLM 5.2、DS 4 还在发力的现在,用 AI 写文档应该很简单……吗?
诶你要这样想那就不对了。让我们来看看一个例子,开源的 Rime 配置 万象拼音 的文档(基于CC-BY 4.0 获得许可):
🛡️ 理念边界与开发者寄语
万象致力于夯实 Rime 生态中的“基础底座”。但为了避免您的预期偏差,我们必须坦诚地说明本项目“不做什么”:
关于学习成本的郑重声明
这里没有输入法基础教学:本项目不负责教您“如何记忆小鹤双拼键位”或“什么是五笔字根”。掌握双拼和辅助码是您提升效率的必经之路,这需要您在兴趣的驱动下自行调研与练习。
不提供保姆级 Rime 扫盲:全网已有海量关于 Rime 引擎基础配置的优秀教程。使用万象需要您具备最基础的折腾精神和软件认知能力。
我们将把所有有限的精力,持续聚焦于优化模型算法、提纯优质词库,力求在底座层面为您提供最坚实的后盾。
为什么虽然感觉词句很正常,但是这段文字仍然有浓烈的「AI 味」呢?原因有以下几点。
- 一就是 Emoji。这是 AI 写文档最致命的缺点:即使它会写 VuePress/VitePress 这样的文档模板库,但是它还是会用 Emoji,而不是用文档模板里的 Icon(Lucide 这些)。
- 二就是一个个的列条目。说实话我这样用
- 来举例也是一种行为,所以不得不说我的说话习惯已经被 AI 深刻影响了,要不然怎么我 Q 昵称是「豆包智能助手」呢(笑)。但是你就看原文里「这里没有……」「不提供……」是不是列条目吧……
- 三就是 AI 式句式。很明显现在 AI 发展趋势是往「会写代码」走,而不是「会说人话」走的。网上 AI Slop 水文越来越多,这些新 AI 在抓训练语料的时候肯定是会抓到越来越多它们同行写的文章的……再加上后期的 Tuning 和每个 AI IDE 里给的质量参差不齐的 Prompt,「不是而是」「诚实的」「致力于」「持续聚焦于」这些词就越来越不像一个正常人写出来的东西了。
- 四就是忽远忽近的距离。这里的「距离」指的是与读者建的距离或者换种方式说就是语言的亲和力。「坦诚地说明」「兴趣的驱动下」「折腾精神」「坚实后盾」这些偏「日常」(好吧有些并不是那么日常)的描述很明显就是拉近与读者之间的距离(冷知识这不是语文阅读理解),但与此同时,「优化模型算法」「软件认知能力」这些专业描述甚至专业人员都不一定看得懂的描述(我猜「软件认知能力」接近于「媒介素养」,但很明显我懒得查)造就了距离的不统一。
如果要一个一个列举这篇文章的长度会接近 ℵ_0,就算是 AI 也不能在有尽的时间内给它写出来,更何况用 AI 批斗 AI 何不就是一种 极大的讽刺 ,所以我就写到这里为止。
那么,如果你就是懒,不想手写文档,又像我一样对 AI Slop 有着很大的厌恶(你猜我现在用不用万象拼音了),那么你该怎么办呢?
继续读下去。
(我不行了虽然单独成段十分有九分的蕴含 AI 风味但是我居然就给他写下来了,完了人类要䛃咭墢灗了😰)
首先,如果你是 API 库或者是造轮子类开发者,你可以尝试不单独写文档而是用自包含文档。用 Python 语言举例:
def some_func(some_args: list[SomeType]) -> SomeType:
"""
一个函数。
Args:
some_args (SomeType): 一群用来啪啪啪的参数。
Returns:
SomeType: 对参数进行啪啪啪处理后的值。
Raises:
SomeError: 参数啪啪啪失败会引发此错误。
"""
这里我们采用了 Google 的 Python Docstring 规范。它既适用于直接阅读,也可以让类似 Sphinx 这些文档构建器读取格式并生成静态页面,供你部署到网站上。
诶但这里就有人要说了,MM 说半天还要我自己写。哎确实,但一个聪明的具有上下文阅读能力的行内补全其实就能完成此操作,何乐而不为呢?诶有有人要说了,MM 说半天还要我自己配置构建。你个老傻子(无恶意),你都用 AI 了,不会给 Agent 开 Computer Use 让它自己配置去?(哦对了记得分我点 Token。)
诶但这里又又又有人要说了,MM 我写的不是 面向开发者的 文档而是 面向用户的使用手册怎么办?(细节不是而是句型)诶,那我这里有点建议就可以给你了。
以上就是全文了。如果你想了解更多,除了文中所给的链接,我还建议你去少数派读读 这个 和 这个,写的都很有深度,我受益匪浅。当然,这篇文章肯定也有许多不完美的地方,作为抛砖引玉,希望能带给你更多的思考,也欢迎你在论坛发表高见。
这篇文章将会是 OhMyIWB 第一篇写给学生开发者的非 Daily 长文,我想就叫它 OhMyIWB Thinklog 吧。论坛特供:Thinklog太长了每次都会开新帖,希望不会打扰到各位版主()原有的 OhMyIWB 会继续更新,那么……
这里是 OMI,欢↗迎↘下↝次↘光↗临-~