跳转到主要内容
反馈功能需要 Pro 或 Enterprise 套餐。
分析页面的反馈部分显示您的页面从用户那里收到的定量点赞与点踩投票,以及用户提供的任何定性反馈。使用这些信息来评估内容质量并进行改进。 查看您的反馈数据可以:
  • 识别成功的内容:获得最多正面反馈的页面显示了您文档中效果良好的部分。
  • 确定改进优先级:获得最多负面反馈的页面表明哪些内容可能需要关注。
  • 采取行动:根据用户的直接反馈进行文档更新。
分析页面中的反馈标签页。

​
启用反馈

如果您在 docs.json 文件中禁用了遥测,则无法启用反馈功能。
要收集和查看反馈,您必须从仪表板中的 Add-ons 页面启用反馈功能。
  1. 导航到 Add-ons 页面。
  2. 启用您想要的反馈类型。
  • Thumbs rating:简单的点赞/点踩投票,用于评估用户对页面的整体满意度。
  • Edit suggestions:允许用户对您的文档提出编辑建议。仅适用于公开的仓库。
  • Raise issues:允许用户直接从您的网站创建 issue。仅适用于公开的仓库。
  • Contextual feedback:关于页面内容的自由格式反馈。可以选择启用电子邮件收集,允许用户在提交反馈时提供其电子邮件地址。
  • Code snippet feedback:专门针对代码片段的反馈。
  • Agent feedback:由访问您文档的第三方 AI 智能体提交的反馈。
Add-ons 页面中的反馈开关。

​
管理反馈

您可以设置某条反馈的状态,并添加内部备注,以跟踪您处理用户反馈的进度。

​
更改反馈状态

选择某条反馈旁边的状态,将其标记为 Pending(待处理)、In Progress(进行中)、Resolved(已解决)或 Dismissed(已忽略)。 设置反馈状态的最佳实践:
  • Pending:反馈正在等待审核。
  • In Progress:正在处理该反馈。
  • Resolved:您已解决该反馈。
  • Dismissed:反馈无关或不准确。

​
按状态筛选

使用 Filters 菜单控制显示哪些反馈。清除某个状态可以隐藏所有该状态的反馈。默认情况下会显示所有反馈类型。

​
按类型筛选

根据您想要分析的信息,在 Ratings by page、Detailed feedback 和 Code snippets 之间进行选择。
  • Ratings by page:查看哪些页面收到的正面和负面反馈最多。使用这些定量数据来识别用户认为最有帮助和最没有帮助的页面。
  • Detailed feedback:查看用户在页面上留下的开放式反馈,以识别针对特定页面的定向改进。详细反馈仅显示包含额外信息的反馈。仅使用点赞或点踩评分而未选择其他反馈选项的提交不会出现在详细视图中。
  • Code snippets:查看用户在代码片段上留下的开放式反馈,以识别针对特定代码块的定向改进。

​
添加内部备注

点击某条反馈以添加内部备注。这些备注仅对有权访问您仪表板的人员可见。 使用备注来添加协作信息、链接相关的支持或工程工单,或记录任何其他有用的信息。

​
智能体反馈

智能体反馈处于测试版,可能会发生变化。
当第三方 AI 智能体获取您的文档时,它们可以针对发现不正确、过时或难以使用的页面提交结构化反馈。 这些反馈会显示在 Detailed feedback 部分,并带有 Agent 标记。管理智能体反馈的方式与管理人类反馈相同。

​
智能体反馈的工作原理

您必须在仪表板中启用智能体反馈才能收集它。 启用后,当智能体使用 Markdown 导出获取页面时,Mintlify 会附加一个 <AgentInstructions> 块,其中包含说明以及用于提交反馈的端点。 智能体使用页面路径和反馈文本将反馈发送到该端点。反馈将与人类反馈一起显示在仪表板中。 即使您没有在 Markdown 导出中添加相关说明,反馈端点始终可通过 POST 请求在 https://your-domain.com/feedback 上获取。您可以提示智能体通过向该端点发送请求来手动提交反馈。

​
通过 API 获取智能体反馈

使用分析反馈端点以编程方式获取智能体反馈。使用 source=agent 进行筛选,仅返回智能体反馈。 智能体反馈响应包括:
  • comment:智能体提交的反馈文本。
  • path:反馈所针对页面的路径。