Scaffold-ETH 2 项目脚手架 README 优化方案解析

Scaffold-ETH 2 是一个流行的区块链开发脚手架工具，它帮助开发者快速搭建分布式应用开发环境。在最新版本中，项目团队对 CLI 工具生成的 README 文件进行了重要优化，以提升开发者体验。

原有问题分析

在之前的版本中，通过 CLI 工具生成的 monorepo 项目 README 文件存在一个明显问题：无论用户选择 Hardhat 还是 Foundry 作为开发框架，README 都只显示 Hardhat 相关的使用说明。这会给使用 Foundry 的开发者带来困惑，需要额外查阅文档才能获取正确的开发指引。

解决方案设计

项目团队提出了两种优化方案：

1. 简单方案：修改基础模板中的 README 文件，同时包含 Hardhat 和 Foundry 的使用说明。这种方案实现简单，但会导致文件内容冗长，且包含不相关的信息。

2. 优化方案：为不同框架创建独立的 README 文件，分别放置在对应的扩展模板目录中。这样可以根据用户选择的框架生成对应的文档，提供更精准的指引。

经过讨论，团队最终选择了第二种方案，因为它能提供更清晰、更有针对性的文档体验，符合现代开发工具的最佳实践。

技术实现要点

1. 模块化文档结构：将框架特定的文档与框架代码一起维护，确保文档与功能同步更新。

2. 动态生成机制：CLI 工具在项目初始化时，会根据用户选择的框架自动复制对应的 README 文件到项目根目录。

3. 内容专业化：每个框架的文档都专注于该框架特有的命令、配置和开发流程，避免无关信息干扰。

开发者体验提升

这一改进带来了多方面的好处：

• 降低认知负担：开发者只看到与他们选择的框架相关的信息，不会被其他框架的内容干扰。

• 减少错误操作：避免了开发者误用不适用于当前框架的命令或配置。

• 维护便利性：框架特定的文档与代码一起维护，更容易保持同步更新。

总结

Scaffold-ETH 2 对 README 文件的这一优化体现了对开发者体验的重视。通过模块化和针对性的文档设计，项目不仅解决了原有问题，还为未来的扩展奠定了基础。这种设计思路也值得其他开发工具借鉴，特别是在支持多种技术栈的场景下。