从用户收集反馈和建议

以 Markdown 格式查看

Fern 提供了多种方式来跟踪用户的反馈和改进建议。

页面反馈

默认情况下,文档的每个 Markdown 页面底部都包含一个反馈组件:

页面反馈

您也可以为单个页面所有页面禁用此功能。

自托管用户反馈

自托管部署中,反馈事件以结构化 JSON 格式记录到容器的 stdout。详情请参阅页面反馈

在仪表板中查看反馈

您可以在 Fern DashboardFeedback 选项卡中查看所有页面反馈回复。表格显示每个页面的反馈,包括页面是否有用以及原因(如果提供),以及渠道、位置和日期。您可以按日期范围筛选并将结果导出为 CSV。

编辑此页面

允许用户直接从您的文档中建议对当前页面的更改。此功能有两种模式:

  • GitHub(默认): 点击按钮直接链接到 GitHub 存储库中页面的源文件,用户可以在此建议更改。这对于具有公共存储库的公开网站是理想的选择,允许外部用户提交拉取请求。
  • Dashboard: 点击按钮打开一个屏幕,用户可以选择为该页面启动 Fern Editor 会话或导航到 GitHub 上的源文件。这对于内部网站特别有用,因为许多或大多数查看者也具有编辑器访问权限,可以直接通过 Fern Editor 进行更改。
Dashboard 模式

您可以在全局配置中配置此功能,包括按钮是直接链接到 GitHub 还是提供编辑选项。您也可以在前置元数据中覆盖单个页面的编辑 URL。

此功能在预览链接中有效,但在本地开发中不起作用。