Skip to content

UserGuide.md audit: inaccuracies and missing content #33

@vdua

Description

@vdua

Summary

Audited guides/UserGuide.md against the live dashboard at http://localhost:3000/?startDate=2026-02-26&endDate=2026-02-26&url=https%3A%2F%2Fapplyonline.hdfcbank.com%2Fcards%2Fcredit-cards.html&tab=error. Found 4 inaccuracies and 8 missing items.


Inaccurate (guide says something wrong)

1. Timezone note position — Error Rate Per Hour chart

  • Guide says (line 134): "A note below the chart shows your local timezone (e.g., 'UTC+05:30')"
  • Actual: The note All times displayed in your local timezone (UTC+05:30) appears above the chart, between the stats panel and the chart. Same layout on the Performance chart.

2. Performance chart title — "Form Block Load Time"

  • Guide says (line 303): "In the UI the main chart title may read Form Block Load Time — this is the same metric."
  • Actual: The chart title is "Engagement Readiness Time (Form Visibility) Percentiles Per Hour". There is no "Form Block Load Time" title anywhere in the UI.

3. Error Details Panel is always visible, not click-to-reveal

  • Guide says (lines 157–162): "When you click on a point in the Error Rate chart, a detailed breakdown panel slides into view"
  • Actual: The "Error Details for -" panel is always rendered below the chart showing aggregate data by default. It does not appear only on click — clicking a point just updates its title and filters data to that hour.

4. Distribution histogram bucket description is wrong

  • Guide says (line 417): "The chart divides all recorded load times into five dynamic equal-width buckets derived from the min and max of the data"
  • Actual: The histogram shows 4 fixed, unequal-width buckets: 0ms - 10s, 10s - 20s, 20s - 60s, 60s+. These are not dynamic, not equal-width (10s, 10s, 40s, open-ended), and there are 4, not 5.

Missing (visible in UI, not documented in guide)

5. Date picker quick-select buttons

The UI has prominent Today, Yesterday, Last 7 days, Custom buttons above the Start/End date inputs. The guide only mentions a "date picker" and the 7-day limit — the shortcuts are not documented.

6. "Click on any point..." instructional note above the Error Rate chart

Above the Error Rate Per Hour chart: Click on any point to view detailed error breakdown for that hour. Not mentioned.

7. "Click on p50 or p75 stat cards..." note in Performance

Between Core Web Vitals and the Performance chart: Click on p50 or p75 stat cards above to view that percentile. Not mentioned.

8. "Numbers represent estimated page views (sampled data × weight)" note

Both User Agent Distribution pie charts (Error Analysis and Performance) show this footnote. Not mentioned anywhere in the guide.

9. Performance tab section heading + description

The Performance tab opens with a bold heading "Engagement Readiness Time (Form Visibility)", a description "How long does it take for the form to be visible on the screen?", and an ENGAGEMENT READINESS label grouping the stats cards. The guide skips this layout and jumps straight to describing the stat cards.

10. "Top Sources" panel in the By Source Over Time section

The guide describes only a chart for this section. The actual UI has a "Top Sources" side panel on the left alongside the chart area. Not mentioned.

11. Selected date range summary display

A Selected: 26 Feb 2026 → 26 Feb 2026 (1 day) summary appears top-right of the date picker. Not mentioned.

12. "Page Views with Missing Resources" stat card shows orange 0

The guide says "Values displayed in red indicate concerning metrics." The Page Views with Missing Resources card shows 0 in orange, not red. Orange is not described as a color option for stat cards anywhere in the guide.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions