AI 入门:用 grill-with-docs 一步步跑通第一个项目
学会安装 Node.js、克隆项目、运行 grill-with-docs,用对话方式明确需求,生成可靠的开发规格文档。
很多新手让 AI 写代码时,AI 会凭猜测填上你没说的细节,结果经常出错。今天介绍的 grill-with-docs 是一个帮你「先问清楚需求再写代码」的工具。它会一步步提问,把模糊的想法变成明确的规格,并写入 CONTEXT.md 文件(一份项目背景和术语的说明文档)。下面带你从零开始装好它并跑通第一次。
准备环境
你需要先安装 Node.js(一个让 JavaScript 能在电脑上运行的环境)。
- 打开浏览器,访问 nodejs.org。
- 下载左边“LTS”(长期支持版)的安装包。
- 双击安装,一路点“Next”直到完成。
- 安装后打开终端(Windows 按 Win+R 输入 cmd,Mac 打开“终端”应用)。
- 输入
node -v回车,如果显示版本号(比如 v18.x.x)就说明安装成功。
安装 grill-with-docs
这是一个 npm 包(Node.js 的软件包,就像手机上的 App)。
- 在终端里输入
npm install -g grill-with-docs并回车。这会全局安装工具。 - 等待安装完成,看到进度条走完即可。
- 输入
grill-with-docs --version检查是否装好,有版本号输出就成功了。
常见坑:如果提示权限错误,Mac/Linux 请在命令前加 sudo,Windows 以管理员身份运行终端。
运行你的第一个项目
用这个工具来为一个简单需求生成规格文档。
- 新建一个空文件夹,比如
my-project,在终端里进入该文件夹:cd my-project。 - 输入
npx grill-with-docs并回车。工具会启动一个交互式问答。 - 它会问你的项目是干什么的。例如输入“一个在线预约系统”。
- 接着会问很多细节,比如“客户是否需要注册才能预约?”“两个人能同时预约同一个员工吗?”等。每问一句,你就输入你的想法。
- 回答完所有问题后,工具会在文件夹里生成两个文件:CONTEXT.md(项目术语和背景说明)和 spec.md(详细需求规格)。
提示:如果回答错了或想修改,可以重新运行,它会覆盖旧文件。
验证是否成功
用文本编辑器(比如记事本或 VS Code)打开 CONTEXT.md,你会看到类似这样的内容:
- 术语定义:比如“Customer(客户)指未登录即可预约的人”。
- 业务规则:比如“每位员工同一时间只能被一人预约”。
打开 spec.md,里面是清晰的功能列表。这些就是你可以直接给 AI 或开发者用的规格。
下一步可以做什么
- 把生成的 spec.md 作为提示词喂给 AI 编码助手,它就不会瞎猜了。
- 试着用 grill-with-docs 为你的其他项目(比如记账 App、博客系统)生成规格。
- 如果对 Node.js 不熟,可以搜索“Node.js 入门教程”进一步学习。
内容来源
DEV Tutorial
发布时间
2026-07-13 01:31