DropComments

在你的应用内收集反馈

DropComments SDK

只需一个 script 标签、服务器上的一个接口,再加上你自己的反馈按钮,就能在正在开发的应用中收集反馈。团队可以直接在应用上标注评论、画框或涂画,用户则通过简短表单提交反馈。所有反馈都会汇总到你在这里的项目中,供你和 AI 智能体回复。

安装 SDK

免费开始。应用密钥始终保存在你的服务器上。

应用反馈,不该从截图开始

测试应用的人发现问题后,先截图、裁剪,再粘贴到聊天里,写上“第二个页面顶部的那个东西”。你再去找那个页面,猜他说的是哪个。

在应用中加入脚本后,他们就能直接指出问题所在。评论会附上当时的屏幕截图、标记的位置和发送者信息,方便你或编程智能体着手修复,回复也会显示在应用中。

如何使用

  1. 1

    添加应用

    在账户的“应用”中填写应用名称、运行地址,以及接收反馈的项目,比如一个用于团队反馈,一个用于客户反馈。添加后,应用会获得一个密钥。

  2. 2

    添加脚本

    应用服务器保存密钥,并根据当前登录用户向页面提供短期令牌,注明该用户是否属于团队。页面加载一个 script 标签,由你自己的反馈按钮打开反馈界面。把 DropComments 显示的内容粘贴给开发应用的智能体,它就会完成添加。

  3. 3

    接收反馈

    团队成员点击“反馈”,在对应位置标注并写下评论;他们能在应用上实时看到所有人的标注和每条回复。其他人则会看到简短表单。每条反馈都会成为对应项目中某个 Drop 的一个屏幕。

安装 SDK

适用于有服务器、且用户需要登录的网页应用。无需安装软件包:在服务器上保存密钥,添加一个向页面提供令牌的接口、一个 script 标签,再加上你自己的按钮来打开反馈界面。

  1. 在 DropComments 的“应用”中添加应用:填写名称、运行地址(使用 https;开发时 localhost 和 .test 可使用 http),以及接收反馈的项目。你会获得应用密钥和各项目的 id。

    添加应用

  2. 将密钥保存在服务器上,放入环境变量或机密配置中:

    DROPCOMMENTS_KEY=dc_app_…

    绝不要放在页面、发送到浏览器的代码或代码提交中。DropComments 会拒绝浏览器使用该密钥发起的请求。

  3. 添加令牌接口。它根据当前登录用户向 DropComments 请求令牌,并原样返回 JSON。无人登录时,返回 401,页面上不会显示任何反馈界面。

    // GET /api/feedback-token
    export async function GET(request) {
      const user = await getSignedInUser(request); // your own sign-in
      if (!user) return new Response(null, {status: 401});
    
      const res = await fetch("https://dropcomments.com/api/app/token", {
        method: "POST",
        headers: {
          authorization: `Bearer ${process.env.DROPCOMMENTS_KEY}`,
          "content-type": "application/json",
        },
        body: JSON.stringify({
          project: "YOUR_PROJECT_ID",
          user: {id: user.id, name: user.name},
          team: user.isStaff, // true: pin comments on the app. false: the short form
        }),
      });
      return new Response(res.body, {status: res.status, headers: {"content-type": "application/json"}});
    }

    示例使用 Next.js 路由处理函数编写;在 Worker、Deno 或 Bun 中做法相同。在 Express 中,返回相同的状态码和 JSON 即可。

  4. 在每个页面的 </body> 之前加载脚本:

    <script src="https://dropcomments.com/live.js" data-token-url="/api/feedback-token"></script>

    脚本本身不会生成按钮,所以此时还不会显示任何内容。

  5. 添加你自己的反馈按钮,在 DropComments.ready 表示已收到令牌之前保持隐藏;点击后,为团队打开面板,为其他人打开简短表单:

    <button id="feedback" hidden>Feedback</button>
    
    const button = document.getElementById("feedback");
    if (await DropComments.ready) {
      button.hidden = false;
      button.addEventListener("click", () => DropComments.open());
    }

    把按钮放在适合应用的位置:页头、菜单或设置页面。面板、表单和标注由脚本提供。

  6. 如果页面发送了 Content-Security-Policy,请允许 DropComments:

    script-src https://dropcomments.com;
    connect-src https://dropcomments.com wss://dropcomments.com;

也可以交给编程智能体完成。添加应用后,你会看到一份已填入密钥和项目 id 的接入说明;把它粘贴给开发应用的智能体,它就会添加接口、脚本和按钮。

参考文档

令牌

服务器调用 POST https://dropcomments.com/api/app/token,将应用密钥作为 Bearer 令牌。project 为必填项,使用项目 id。user 是当前登录用户;如果未提供姓名,面板会要求用户填写。team 决定用户可使用哪些工具。令牌有效期为一小时,脚本会在到期前向你的接口请求新令牌。

{
  "project": "YOUR_PROJECT_ID",
  "user": {"id": "u_123", "name": "Sam Lee"},
  "team": true
}
// → {"token": "dct.…", "expiresAt": …, "team": true, "project": {…}}

脚本选项

data-token-url 是你的接口地址,请求时会携带页面的 Cookie;接口可以返回令牌的 JSON,也可以以纯文本返回令牌。data-ui="none" 完全不显示界面,供你使用自己的表单:通过 DropComments.send() 发送表单收集的内容。团队成员在电脑上发表评论时,除截图外还会附上页面副本:在 Drop 中点击页面按钮即可查看,页面支持滚动和选中文字,智能体也能读取其中的文字。data-capture="picture" 仅发送截图。手机和平板始终只发送截图。

<script src="https://dropcomments.com/live.js"
  data-token-url="/api/feedback-token"
  data-capture="picture"></script>

JavaScript

脚本加载后,所有功能都可通过 window.DropComments 使用。ready 表示是否已收到令牌,因此只在收到令牌后显示按钮。

await DropComments.ready; // true once a token came
DropComments.open();  // the team’s panel, or everyone else’s form
DropComments.close();
await DropComments.send({text: "The total is wrong", picture: true});
await DropComments.link(); // the team’s feedback in DropComments, or null

沿用应用的外观

反馈按钮的样式由你决定。在 :root 上设置这些变量,面板、表单和标注也会采用相应样式。其他变量包括:--dc-muted、--dc-line、--dc-soft、--dc-on-accent、--dc-accent-text、--dc-pin、--dc-on-pin 和 --dc-button-radius。

:root {
  --dc-font: "Inter", sans-serif;
  --dc-surface: #ffffff;
  --dc-text: #111827;
  --dc-accent: #4f46e5;
  --dc-radius: 12px;
}

保护隐私

评论会附带屏幕截图,因此屏幕上的内容都会显示,包括已输入的文字(密码显示为圆点)。标记任何绝不能离开应用的内容后,它们会在截图中显示为灰色方块,并从页面副本中排除。页面副本不含脚本,输入字段也会留空。

<div data-dc-hide>
  Card ending 4242
</div>

你能获得什么

团队测试版本

在电脑或手机上,直接在运行中的应用上标注、画框或涂画。每条评论都会附上标明位置的屏幕截图,电脑上还会附上页面副本,所以只说“这里坏了”就够了。

应用用户

简短表单提供“指出位置”功能,并附有屏幕截图。用户看不到其他人的反馈,只有保留截图选项的勾选状态才会发送截图。

内测用户和客户

让参与试用的人登录,并决定哪些人属于团队。客户评审预发布网站时,可以直接在网站上留下意见。

由智能体修复

连接到 DropComments 的编程智能体会读取每条评论及其所在页面,完成修改并回复。回复会显示在应用中。

与你的应用风格一致

只需几个 CSS 变量,用户表单就能采用你的配色、字体和圆角;也可以使用自己的表单,通过一次调用发送反馈。

密钥始终由你保管

密钥保存在服务器上,绝不放在页面中。仅接收来自应用指定地址的反馈,按用户限制提交频率,并通过 id 选择每个项目。

反馈直达收件箱

每条反馈都会成为所属项目收件箱中的一张工单,等待有人接手。

常见问题

任何应用都能用吗?

只要是有服务器、且用户需要登录的网页应用就可以:服务器会告知 DropComments 每位用户的身份。游戏和其他使用 canvas 绘制界面的应用也能使用;画布内容会以图片形式传送。

团队评论会发送哪些内容?

一张当时屏幕的图片,其中标有 data-dc-hide 的内容会显示为灰色。在电脑上,还会附上一份页面副本(除非你设置了 data-capture="picture"):内含样式和图片,不含脚本,已填写的字段会留空,标有 data-dc-hide 的内容会被移除,另外还附有所标位置的图片。Drop 默认显示图片,在电脑上可以切换到页面。图片由脚本根据页面布局绘制,因此接近原貌,但并不完全一致:变换、滤镜以及 ::before 或 ::after 内容会以普通样式呈现。该画面还会保留采集时的信息:页面地址(不含 #fragment)、页面标题、窗口尺寸和浏览器。

可以将客户和团队的反馈分开吗?

可以。一个应用可以将反馈发送到多个项目,由应用服务器为每个人指定项目,这样团队的反馈就能进入一个项目,其他人的反馈则进入另一个项目。

费用是多少?

所有套餐都包含此功能。免费套餐中,每个收集反馈的 Drop 开放评论一天,之后会新建一个;Pro 则会持续开放。

继续阅读

下一个文件,就用它试试

大约十秒,就能获得分享链接。

拖入文件