Skip to content

Add Usability Issue Detection docs page#38106

Open
abhi-motgi wants to merge 7 commits into
masterfrom
abhi-motgi/sr-usability-issue-detection
Open

Add Usability Issue Detection docs page#38106
abhi-motgi wants to merge 7 commits into
masterfrom
abhi-motgi/sr-usability-issue-detection

Conversation

@abhi-motgi

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Adds a new Product Analytics documentation page for Usability Issue Detection (Preview) and registers it in the Product Analytics sidebar navigation.

The page covers:

  • Overview and the three issue categories (System failure, Slow performance, User confusion)
  • Prerequisites (Session Replay + Product Analytics, and the session_replay_analysis_write permission)
  • Triggering an analysis from a funnel or from the Usability page
  • Viewing issues, issue details, and analysis history
  • Data retention behavior
  • Triaging issues (New, Reviewed, Resolved, Ignored)

Merge readiness

  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Used Claude (Cowork) to draft and iterate on the page from internal source docs, apply the Datadog docs style guide, place screenshots, and set up the nav entry. Content and structure reviewed and edited manually.

Additional notes

@abhi-motgi abhi-motgi requested a review from a team as a code owner July 10, 2026 18:48
@github-actions github-actions Bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Jul 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

@hestonhoffman hestonhoffman added the editorial review Waiting on a more in-depth review label Jul 10, 2026
@hestonhoffman

Copy link
Copy Markdown
Contributor

Hello! I've created a docs ticket for this one. Someone will be along to review it soon!

@rtrieu

rtrieu commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

/review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Automated review by Claude. AI-generated; verify before acting.

Nice, clean addition. A few notes: the frontmatter is missing a description (used across other Product Analytics pages for SEO/AI ingestion), and a couple of clarity/hyphenation nits in the body. No blockers.

Reviewed a57710c27a07c7f7bc399622e696709e4000f456workflow run

Comment thread content/en/product_analytics/usability.md
Comment thread content/en/product_analytics/usability.md Outdated
Comment thread content/en/product_analytics/usability.md Outdated
Comment thread content/en/product_analytics/usability.md Outdated
@rtrieu

rtrieu commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

for the issue details image, let's use this version where the detailed page is highlighted and the main page is darkened so it's a bit easier to see:
issue-details-1

Another option:

usability-diagram

@datadog-datadog-prod-us1-2

This comment has been minimized.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Comment thread content/en/product_analytics/usability.md Outdated
Comment thread content/en/product_analytics/usability.md Outdated

@rtrieu rtrieu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving, but would recommend swapping one of the images before publishing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants