Skip to content

Commit 6cf4585

Browse files
ethanpalmethanpalm
authored
Feedback docs (#1080)
* update analytics intro * update overview intro * update feedback section * update search intro * create Analytics dashboard group * create new analytics pages * update docs.json with new pages * delete guides/analytics * update overview * update search * update improving docs * add link to dashboard * polish overview * fix casing * polish search * update feedback * consistency with other pages * make improving docs more actionable * polish improving docs
1 parent 7050dd9 commit 6cf4585

File tree

6 files changed

+150
-52
lines changed

6 files changed

+150
-52
lines changed

‎analytics/feedback.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Feedback"
3+
description: "Monitor user satisfaction with your documentation"
4+
---
5+
6+
<Info>
7+
To collect and view feedback, you must first enable feedback from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard.
8+
</Info>
9+
10+
The feedback tab displays quantitative thumbs up and thumbs down votes your docs have received and any qualitative feedback that users have provided. Use this information to gauge the quality of your docs and make improvements.
11+
12+
Access the feedback tab by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics).
13+
14+
## Feedback types
15+
16+
The feedback tab displays information according to the feedback add-ons that you enable.
17+
18+
Enable your preferred feedback types:
19+
20+
* **Thumbs rating only**: Simple thumbs up/down voting to gauge overall satisfaction with pages.
21+
* **Code snippet feedback only**: Feedback specifically on code snippets.
22+
* **Thumbs rating and contextual feedback**: Page voting plus detailed comments and reasons for ratings.
23+
* **Thumbs rating and code snippet feedback**: Page voting plus feedback on code examples.
24+
* **Thumbs rating, contextual, and code snippet feedback**: Complete feedback system with page voting, detailed comments, and code snippet feedback.
25+
26+
## Managing feedback
27+
28+
For contextual and code snippet feedback, you can set the status of a piece of feedback and add internal notes to track your work resolving user feedback.
29+
30+
### Changing feedback status
31+
32+
Select the status beside a piece of feedback to mark it as **Pending**, **In Progress**, **Resolved**, or **Dismissed**.
33+
34+
Best practices for setting feedback statuses:
35+
36+
* **Pending**: Feedback is awaiting review.
37+
* **In Progress**: Feedback has been validated and is being worked on.
38+
* **Resolved**: Feedback has been resolved.
39+
* **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.
40+
41+
### Filtering by status
42+
43+
Use the status filter to control which feedback is displayed. Uncheck a status to hide all feedback with that status. By default, all feedback is displayed.
44+
45+
### Adding internal notes
46+
47+
Click on a piece of feedback to add an internal note. These notes are only visible to people with access to your dashboard.
48+
49+
Use notes to add information for collaboration, link relevant support or engineering tickets, or remember any other useful information.
50+
51+
## Using feedback data
52+
53+
Review your feedback data to:
54+
55+
* **Identify successful content**: Pages with the most positive feedback show what works well in your documentation.
56+
* **Prioritize improvements**: Pages with the most negative feedback indicate what content might need attention.
57+
* **Take action**: Make documentation updates based on direct user feedback.

‎analytics/improving-docs.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Improving your docs"
3+
description: "Use analytics data to make your documentation better"
4+
---
5+
6+
Improve your docs based on quantitative and qualitative data from your analytics dashboard.
7+
8+
## Cross-analytics insights
9+
10+
Combine information from multiple analytics sources to get a holistic view of your documentation.
11+
12+
### Correlate traffic and satisfaction
13+
- **High traffic and low feedback scores**: Popular pages with a poor user experience. Prioritize improving these pages.
14+
- **Low traffic and high feedback scores**: Documentation that is working well, but might not be discoverable. Consider promoting these pages.
15+
- **High traffic and high feedback scores**: Your documentation's greatest hits. Review these pages for ideas to improve the rest of your content.
16+
17+
### Match search intent with content performance
18+
- **High search volume and low page views**: Discoverability problems. Consider moving these pages or reviewing their frontmatter.
19+
- **Popular search terms and low-confidence results**: Content gap opportunity. Consider adding more content or new content on these topics.
20+
- **Top searches and negative feedback on matching pages**: User experience issues. Review the pages to see if they solve the user need that is being searched for.
21+
22+
## Put insights into action
23+
24+
Use these cross-analytics patterns to prioritize your documentation improvements:
25+
26+
- **Fix high-impact problems first**: Popular pages with poor feedback scores affect the most users.
27+
- **Fill verified content gaps**: Low-confidence searches with high volume indicate unmet user needs.
28+
- **Respond to user feedback**: Contextual and code snippet feedback can identify specific areas for improvement.
29+
- **Align search and content**: Ensure your most-searched topics have comprehensive, well-organized pages.
30+
- **Monitor rising search trends with no existing popular pages**: New content opportunities.

‎analytics/overview.mdx‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Overview"
3+
description: "View traffic and high-level insights about your documentation"
4+
---
5+
6+
The overview tab shows how many people have visited your docs, what pages are most popular, and where users are coming from. Use this information to identify which pages are most valuable to your users and track trends over time.
7+
8+
Access the overview metrics by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics).
9+
10+
## Metrics
11+
12+
Use the range selector to adjust the time period for displayed data. Select visitors, views, or actions to display a line graph showing trends over the selected time period.
13+
14+
- **Visitors**: Unique visitors
15+
- **Views**: Total page views
16+
- **Actions**: Combined count of API calls, navbar link clicks, and CTA button clicks
17+
- **Popular Pages**: Paths to the most-visited pages and their view counts
18+
- **Referrers**: Top traffic sources directing users to your docs
19+
20+
## Using overview data
21+
22+
Review your overview analytics to:
23+
24+
- **Identify popular pages**: Use popular pages to understand what content is most important to your users so that you can make sure it is up to date and comprehensive.
25+
- **Track traffic trends**: Monitor changes in traffic to understand the impact of updates or new content.

‎analytics/search.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Search"
3+
description: "Understand how users search within your documentation"
4+
---
5+
6+
Use the data on the search tab to understand what users are searching for and identify topics that need to be updated or expanded.
7+
8+
Access your search metrics by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics).
9+
10+
## Search metrics
11+
12+
Use the range selector to adjust the time period for displayed data.
13+
14+
- **Total queries**: Search volume
15+
- **Top searches**: Most-searched terms
16+
- **Low-confidence searches**: Queries that may not have returned relevant results
17+
18+
## Using search data
19+
20+
Review your search analytics to:
21+
22+
- **Identify popular topics**: Use top searches to understand what content people want to find.
23+
- **Find content gaps**: Low-confidence searches may indicate missing documentation or topics that need better coverage.
24+
- **Improve discoverability**: Ensure that pages matching popular search terms are easy to find and well-organized.

‎docs.json‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,16 @@
135135
"group": "Guides",
136136
"pages": [
137137
"guides/migration",
138-
"guides/analytics",
138+
{
139+
"group": "Analytics dashboard",
140+
"icon": "chart-line",
141+
"pages": [
142+
"analytics/overview",
143+
"analytics/feedback",
144+
"analytics/search",
145+
"analytics/improving-docs"
146+
]
147+
},
139148
"react-components",
140149
"settings/custom-scripts",
141150
"settings/seo",
@@ -528,6 +537,10 @@
528537
{
529538
"source": "editor",
530539
"destination": "editor/getting-started"
540+
},
541+
{
542+
"source": "guides/analytics",
543+
"destination": "analytics/overview"
531544
}
532545
],
533546
"integrations": {

‎guides/analytics.mdx‎

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)