
AIDA 工具发布:用编码 agent 自动生成应用操作指南和配音教程
来源标题:Show HN: AIDA – agentic generated user guides
AIDA(Agent-driven Instruction and Documentation Automation)可让编码 agent 为 Web 应用编写分步操作指南,并在真实浏览器中针对运行中的应用逐条执行验证。每条指南会从同一份文件生成带截图的帮助页面、可打印指南和配音视频。当 pull request 改动某个界面时,CI 会重新运行受影响的指南,并报告哪些页面发生变化、哪些失效。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
把你的应用变成用户指南和带旁白的教程。AIDA(Agent-driven Instruction and Documentation Automation,智能体驱动的说明与文档自动化)会配合你的编码智能体,为你的 Web 应用编写分步操作演示,然后在真实浏览器里针对正在运行的应用逐条执行。每一条操作演示都会变成一个帮助页面,包含截图、可打印指南和带旁白的视频,全部来自同一个文件。当某个 pull request 改动了某个界面时,CI 会重新运行受影响的演示,并告诉你哪些页面变了、哪些页面坏了。
aida-explainer-github.1.mp4
从一条提示开始
让你的应用在本地连接一个一次性数据库运行,在应用的代码仓库中打开你的编码智能体,然后粘贴:
用 AIDA 为这个应用生成帮助文档,npm 包名是 aida-docs(千万不要运行 npx aida:那是一个无关的包)。
- 运行
npx aida-docs init . - 运行
npx aida-docs skills install --target . --agent <you>,其中 <you> 是 claude、codex、gemini、cursor、copilot、opencode 或其他。 - 阅读安装好的 aida skill(.claude/skills/aida/SKILL.md 或 .agents/skills/aida/SKILL.md)并按照它操作,从
npx aida-docs doctor --config help/aida.config.ts开始。 智能体会搭建帮助站点、梳理你的应用、请你确认一份指南清单,然后编写、捕获并检查每一条指南。快速开始里有手动操作的相同步骤。 你(或你的智能体)为每个任务写一个操作演示文件。每一步说明要做什么、要说什么,以及读者应该看到什么: walkthrough: invite-a-teammate title: Invite a teammate for: Workspace admins start: signed_in_as: admin page: /settings/team steps:
- id: open-invite title: Open the invite form say: Click Invite teammate. caption: Click Invite teammate. page_text: Click Invite teammate. actions:
- do: click target: { role: button, name: Invite teammate } highlight: true
...enter their email, choose a role, send
aida build 会针对你的应用重新执行它,并生成: help/ walkthroughs/invite-a-teammate.yaml 唯一事实来源 pages/invite-a-teammate/index.mdx 帮助页面 pages/invite-a-teammate/screenshots/ step-01.png、step-02.png、…… videos/invite-a-teammate/ .mp4、.srt、.vtt、.chapters.vtt pdf/ invite-a-teammate.pdf、.card.pdf、manual.pdf 帮助站点是你仓库里一个普通的 Next.js 应用。在本地 Studio 中编辑文字和截图标注(在 help/ 里运行 npm run dev,然后打开 /studio),再部署到任何能运行 Next.js 的地方:Vercel、Netlify、AWS Amplify、Cloudflare、Node 服务器或静态托管。 Rallly 是一个开源会议调度工具(Next.js、better-auth、Prisma)。我们用它的演示数据对一个本地副本运行了 AIDA:23 条操作演示,每一条都在真实浏览器中重新执行,下面所有输出都直接来自 aida build,未经编辑。配置、登录适配器和各条演示都在 examples/rallly 里。 帮助站点。一个按主题分组的首页,每个任务一个页面,包含带编号的截图、视频、PDF 下载和一个「在应用中已检查」的日期。简报还额外生成一个术语表和一个「须知」规则页面。 带旁白的视频。45 秒,五个步骤:打开 Finalize、选择日期、选择通知对象、确认,以及参与者收到的「Date booked」邮件(Rallly 的真实邮件,在发出途中被截获,从未真正发送)。字幕和章节随之一起生成。 可打印指南和速查卡。同样的步骤做成一份 A4 指南和一张单页卡片。 下载指南(PDF) · 下载卡片(PDF) 你需要 Node 22+ 和位于 PATH 中的 ffmpeg,并且你的应用要连接一个一次性数据库在本地运行。AIDA 在 npm 上的包名是 aida-docs(npm 上的 aida 名称是一个无关的包)。 npx playwright install chromium npx aida-docs init ~/my-app # 添加 ~/my-app/help 并安装它 npx aida-docs doctor --config ~/my-app/help/aida.config.ts # 检查机器和应用,每个问题给出一条修复建议 npx aida-docs skills install --target ~/my-app # 添加智能体技能(其他智能体用 --agent codex 等) 或者只安装一次(npm install -g aida-docs),然后运行 aida <command>。如果你想开发 AIDA 本身,请参阅 Contributing。 然后在 ~/my-app 中打开你的编码智能体并提问: 智能体会梳理你的应用、提出一份供你确认的指南清单、编写并捕获每一条操作演示,并修复失败的部分。要查看结果,在 help/ 里运行 npm run dev 并打开站点。运行 npx aida-docs build --config help/aida.config.ts 可以自己重新构建全部内容。 请针对应用的生产构建(next build && next start)进行捕获,而不是开发服务器。docs/setup.md 涵盖登录适配器、通过隧道访问 Studio,以及所有命令。 AIDA 的引擎是一个确定性的 CLI,从不需要模型。你的编码智能体使用 skills/ 中的技能完成判断类工作:规划要记录什么、编写操作演示、修复损坏的演示、审查输出。它们是普通的 Agent Skills(SKILL.md 文件夹),所以任何能读取该格式的智能体都能运行它们。唯一与 Claude 相关的部分是 subagent 文件,它按任务选择模型;其他智能体在你选定的模型上运行每一步,这可行,但在大型应用上成本更高。 aida init --ci 会添加一个 GitHub workflow。在每个 pull request 上它会: 基础 workflow 不使用模型,也不需要 API key。详情和选项见 docs/ci.md。 除非应用可能连接到的每个数据库都在你的机器上(或者是你精确命名的某个一次性数据库),否则捕获会拒绝运行。 它会对真实的邮件和短信发送器发出警告,并拒绝使用真实支付密钥。 写入步骤只针对本地应用运行。 截图中的个人信息会被模糊处理,每个输出在发布前都会扫描个人信息和密钥。 演示数据使用 example.com 地址和保留的虚构电话号码。 智能体不能批准首次生产发布。必须由人来批准。 完整细节见 docs/setup.md。 AIDA 处于预发布阶段。它已在几个真实的 Next.js 应用上端到端运行过,但还没有外部用户。可能会有粗糙之处和破坏性变更。 详细计划见 docs/scope.md,里程碑状态见 docs/build-plan.md。 npm install
(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。