新人第一天总卡在 QuickStart？聊聊把 README 纳入 CI 自动化验证的工程化落地

大家团队里有没有遇到过这种情况：新人入职第一天，照着 README 里的 QuickStart 跑，结果卡在第一步，一问才知道某个参数上个月就重构废弃了。

以前我也试过靠 Code Review 时互相提醒，但只要排期一紧，谁都会漏。说白了，全凭自觉的流程迟早会腐烂。

最近我们在试着做「文档工程化」，把文档当代码管：把 QuickStart 里的安装命令、最小示例代码抽出来，挂到 CI 流水线上跑无头验证（比如用类似 pytest-examples 或轻量脚本提取 Markdown 代码块在沙箱里执行）。只要命令跑不通，PR 就直接红掉。

但落地时也遇到团队内部的取舍讨论：

1. 排期与成本：为了让文档里的几行代码在 CI 里跑通，往往要补一堆前置环境和 Mock 数据，维护成本上去了。
2. 文档可读性：如果为了兼顾自动化，把原本很简短的 README 搞得全是“符合测试规范”的代码，会不会本末倒置？

想问问大家，你们团队是怎么防止文档过时的？是宁愿多花 CI 时间做自动化阻断，还是有更轻量、低成本的协作解法？