文档是插件里唯一会告诉你「作者是否希望你成功」的部分。你可以读几个小时的源码,仍然不知道维护者是否真的理解他们的工具是怎么被使用的。但一套文档能在十分钟内暴露这件事——前提是你知道该看哪里。
一、先看快速开始,而不是 API 参考
快速开始是任何文档中最有信息量的一页。好的快速开始能让你在一台干净的机器上、只依靠这一页的内容,五分钟内跑起来。如果你发现自己在补全某个从未展示过的配置文件、某个只在后面章节出现的环境变量,那是维护信号,不是疏漏。
- 是否写明了测试所针对的具体版本?
- 是否展示了预期输出,而不只是命令?
- 零基础照做,能不能真的跑通?
- 是否告诉你如何验证安装成功?
二、检查示例是否可运行
复制粘贴是最诚实的测试。把文档里第一个像样的代码示例原样粘进一个新文件,不做任何修改。如果报错,追问原因:是拼写错误、缺少 import,还是某个两个大版本前就废弃的旧 API?第三种最危险,因为它意味着升级时根本没人跑过文档。
过期示例的启发式
当一个示例从旧包路径导入,或使用库里早已废弃的回调风格,基本可以断定这一页的其余内容同样陈旧。过期的示例几乎从不单独出现。
三、找错误路径
只写顺利路径的文档不是文档,是广告。在文档里搜索「error」「失败」「故障排查」「权限」这类词。成熟的文档会告诉你什么会出错、报错信息意味着什么、该怎么处理。单薄的文档则默认一切永不失败。
四、核实版本管理这件事
文档是否对应某个具体版本,还是一坨声称覆盖一切的、没有日期的内容?找版本选择器、changelog 链接、或大版本之间的迁移指南。迁移指南是项目是否在维护的最强单一信号,因为写它需要真实投入,而只有维护者打算继续做下去时这笔投入才划得来。
五、读贡献与支持部分
这两节告诉你「出事了会怎样」。有记录的 issue 模板、明确承诺的响应窗口、安全披露政策、可见的提交节奏,都说明这个项目有一套运行机制。没有这些不代表插件差——但意味着出事时你得自己扛。
十分钟清单
- 快速开始:照做是否得到可运行的安装?
- 示例:不做修改能否运行?
- 错误:失败模式是否有含义解释与修复方法?
- 版本:是否有 changelog 与至少一篇迁移指南?
- 支持:是否有 issue 模板与明确的响应预期?
- 新鲜度:文档最近一次提交是否在半年内?
拿这份清单去核对三个你已经在用的插件,你很快就会校准出自己的阈值。重点不是要求完美——而是在做出承诺之前,先知道自己在选择什么样的支持。