如何编写安装步骤可复现的 README。
README 应基于已验证要求让安装配置可复现。区分已检查的指令、建议命令和不可用配置。
按任务需求调整流程。
利用仓库的实际脚本、前提条件和配置说明安装及首次使用。区分已验证命令和建议步骤,排除示例中的密钥,并给出明确测试路径。
- 你需要提供什么
- 已验证的项目行为和安装配置要求。
- 你会得到什么
- 包含待验证可执行步骤的项目文档。
查看输入和结果。
演示用输入和输出 · 教学示例,并非 WebAct 实时运行结果
示例 个输入项
Write a minimal README. Fictional project: Tiny Notes. Requires Node 24 and npm, has package-lock.json, scripts dev and test, no environment variables needed for local use.
完整示例
# Tiny Notes A small notes application. ## Requirements Node 24 and npm. ## Local setup Install locked dependencies with `npm ci`. Start development with `npm run dev`, then open the URL printed by the development server. ## Tests Run `npm test`. ## Configuration No environment variables are required for local use. These instructions reflect the supplied project facts; no repository execution is claimed.
将这份输入载入提示词,再复制到 WebAct 中尝试任务。实际结果可能与示例不同。
决策与问题排查。
README 应编造一个听起来常见的安装命令吗?
先检查项目。熟悉的命令也可能不适用于实际包管理器、锁文件或构建流程。
为什么遵循 README 仍然安装失败?
比较运行时版本、必需配置和实际脚本。复现缺失步骤,不要只添加模糊的故障排除段落。
使用自己的资料试一试。
将任务提示词中的示例换成你的材料。保留所需条件,再把任务复制到 WebAct。
自定义并复制任务 ↑