SuperAPI AI 工具集

openbot-copy

写作与研究

查看项目

更新于 11-01 01:59

技能介绍

用途

OpenBot Copy 是一份写作指南,适用于任何一个人会读到的文本字符串,包括标题、描述、按钮、占位符、空状态、通知、聊天卡片,以及浏览器显示的服务器错误。服务器消息同样算在内,例如一个说明下一步操作的 409 错误,就像任何屏幕一样被人阅读。

不适用于写给模型的文本,例如工具描述、常驻指令和提示词,这些会影响 Bot 的行为,修改其措辞属于行为变更,需要单独评审。也不适用于代码注释和 docs/ 目录,后者有自己的语域。

主要能力

词汇表

词汇表的核心原则是:一个事物,在所有用户可见的地方用同一个词。

  • 使用“Bot, Bots”(首字母大写)指代一个人创建、对话并分配工作的对象。不要使用 agent、coworker、assistant、AI。
  • “agent”仅用于外部框架的程序,在涉及连接外部框架的地方使用,例如“an agent you already run”“AG-UI agent”。当指代的是 Bot 时,应使用 Bot。
  • “app”指 Bot 使用的服务,例如 Gmail、Google Drive、Notion。不要使用 connector、integration、plugin(Admin 区域除外)。
  • “Connections”指 Bot 以你的身份使用的应用和账户,以及列出它们的页面。不要使用 connected accounts、linked accounts。
  • “connect / disconnect / reconnect”指一个人对自己的账户所做的操作。不要使用 link(GitHub 和 Slack 身份验证除外,那里“link”是供应商自己的用词)。
  • “Capabilities”指你的技能和 Bot 对你的记忆,以及包含两者的页面。不要使用 plugins。
  • “skill”指通过 / 调用的具名指令。不要使用 command、prompt。
  • “admin”指为所有人运行 OpenBot 的人。不要使用 administrator、owner、operator。
  • “OpenBot”指用户正在使用的产品。不要使用 this deployment、the server、the instance。
  • “turn on / turn off”指管理员切换应用或功能。在句子中不要使用 enable / disable(开关仍可显示“Enabled”)。
  • “conversation”指与一个或多个 Bot 的对话线程。在句子中不要使用 channel、chat。

Admin 区域允许使用确切名称。管理员页面可以提及 COMPOSIO_API_KEY、OAuth 和“deployment”,因为管理员是设置它们的人。任何人都可以打开的页面则不可以。

风格

  • 先说发生了什么,再说该怎么做。例如:“Gmail isn't connected. Connect it to let Bots read your mail.” 不要解释屏幕为什么这样构建。
  • 解释性内容使用完整句子。页面描述、辅助文本、通知和空状态正文需要主语和谓语,或直接指令(如“Connect your accounts”)。避免片段,例如“The apps your Bots use”或“What this Bot can do.”。标题、标签、按钮和短状态标签可以是片段。
  • 只保留有用的解释。说明用户需要的操作、结果或限制。删除仅仅重复标题的文案。使用自然的句子长度;不要为了满足字数而把散文切成片段。
  • 使用平实的词语。“use”而非“hold a grant on”。“can't”而非“is unable to”。可以使用缩写。
  • 不要使用“rather than”、破折号、“which is why”、“so that nothing … that may be wrong”。这些是文本在自我解释的标记。删除该从句,或将其变为独立句子。
  • 在 Admin 之外不要出现内部术语。Composio、OAuth client、credential、token、grant、scope、deployment、broker、endpoint:应说明用户看到的内容,例如“not set up yet”“your account”“this Bot can use it”。
  • 使用第二人称。“Your apps”“you can”。Bot 用“it”。
  • 标题和按钮使用句式大小写,例如“New Bot”“Your connections”。
  • 按钮使用动词:Connect、Request access、Create、Save。按钮不要写“Click here”或“OK”(当它执行具体操作时)。
  • 错误信息:说明什么失败了(用用户的术语)和一个下一步操作。例如:“Couldn't load your connections. Reload the page.” 不要堆叠原因,不要责备。
  • 空状态说明将出现什么以及如何出现。例如:“No skills yet. Write one with New skill.”

修改前后示例

  • 修改前:“The apps and accounts your Bots use as you. Open one to connect it or change it.” 修改后:“Connect your accounts so Bots can use apps on your behalf.”
  • 修改前:“Your connected accounts could not be loaded, so nothing is listed here rather than a list that may be wrong. Reload the page, and tell an administrator if it persists.” 修改后:“Couldn't load your connections. Reload the page, or ask an admin if it keeps happening.”
  • 修改前:“Sent to the coworker it is for. Type @ to choose one yourself.” 修改后:“OpenBot picks the right Bot. Type @ to choose one.”
  • 修改前:“Gmail is a Composio app, and this deployment has no Composio key.”(对非管理员)修改后:“Gmail isn't set up yet. An admin has to turn it on.”
  • 修改前:“The agent is still working on another request. Please wait or stop that task first.” 修改后:“This Bot is still working on something. Wait for it, or stop it first.”

需避免的信号

  • 用“agent”或“coworker”指代 Bot → 改用 Bot。
  • 使用“administrator” → 改用 admin。
  • 在任何人可打开的页面上使用“this deployment” → 改用 OpenBot,或说明缺少什么。
  • 句子超过约 25 个词 → 拆分它,或删除为屏幕辩护的从句。
  • UI 文本中出现“rather than”、破折号、“which is” → 改写为两个短句。
  • 描述以“The apps…”“What…”“Who…”“Where…”开头且没有主要动词 → 用完整句子陈述操作或行为;删除冗余解释。
  • 在 Admin 之外出现环境变量、OAuth、Composio 或“grant” → 说明用户看到的内容。
  • 测试断言冗长的解释性文案 → 断言短句,或断言角色和关键词。

使用方式

该资料为写作指南,未提供具体安装或使用步骤,暂未提供。

适用场景

适用于 OpenBot 产品中所有用户可见文本的编写和评审,包括界面文案、错误提示、空状态、通知等。不适用于模型提示词、代码注释和文档。

限制

该资料未提供具体工具、安装命令或自动化检查方式,暂未提供。