@ScarletKc开发seiso,解决AI文档乱象
讨厌 GPT 在你的文档里到处拉屎? AI 根本没训练过怎么写文档。
README 里写死当前版本号,过两个版本就是错的。同一张字段表复制到三个页面,后来只改了一个。how-to 开头先写一大段为什么选这个方案。最离谱的是结尾还留着一句“需要的话我可以继续帮你改”。
现在读文档的也不只是人,coding agent 也会把它当上下文。人和 agent 都照单全收,一个过期的版本号两边一起坑。
之前我也做过写文档的 skill,但 skill 毕竟不是硬规则,模型遵不遵守全看心情,也没法拦在 CI 前面。
所以我开发了 seiso,一套 Markdown 文档规范加 linter。每篇文档先声明自己是 readme、howto 还是 reference,只写这一类该写的东西。一个事实只放一个地方,其他页面链接过去。README 这类长期文档不写版本号、部署状态这些很快会变的东西。
它不猜文字像不像 AI 写的,只查文档该写什么、事实放在哪、链接对不对。报错会写清楚在哪、怎么改,agent 只看输出就能自己修。也可以挂在 Claude Code 的 hook 上,每次 Write/Edit 完自动检查,有问题直接把诊断丢回给 Claude。
第一版刚发,查过期版本号、重复内容这些规则还在 preview,要加 --preview 打开。cargo、pip、npm 都能装。
试一下