用可运行示例替代文档应对快速迭代的开源项目

一个持续快速迭代的开源项目很难保证文档跟得上代码变化，与其追求写全写细的文档，不如维护一套完整的、可直接运行的训练脚本作为”活文档”：用户照着示例改一改就能跑通自己的场景，比读一篇可能已经过时的说明文字更可靠；同时，示例本身也是一种邀请——鼓励用户把自己基于示例做出的改进反馈回社区，形成”共享示例、共同打磨”的协作模式，而不是单向的”官方写文档、用户看文档”。发散：这也是判断一个技术项目文档策略是否合理的角度——迭代越快的项目，越应该把说明性文字的比重换成可运行、可复制粘贴的示例。