docfriction

这是什么

docfriction 为在线文档页面生成摩擦日志，逐节遍历并询问 TypeSafe Jev 一组固定的类型化问题。它面向希望发现读者卡点的开发者关系人员和文档作者。

它怎么用 Jev

对于每个章节，Jev 回答一个 Choice 问题（涵盖十种摩擦类型以及 no_friction 和 other），一个 Score 问题（四种读者结果，用于评估严重程度），以及若干 Noul（是/否）检查，涉及前提条件、预期结果、未定义术语、代码与正文匹配以及未解释的占位符。概率通过阈值转化为发现项；不确定的答案标记为“需要审查”。

用到的原语:choicescorenoul

值得抄的做法

使用类型化问题（Choice、Score、Noul）结合概率和阈值，将主观的文档摩擦转化为确定性的、可在 CI 中设门的发现项。

怎么试

uv tool install docfriction; docfriction https://docs.example.com/quickstart --dry-run; export TYPESAFE_API_KEY=...; docfriction https://docs.example.com/quickstart

去 GitHub 看