Page MenuHomePhabricator

SDS 2.4.20: Improve docs on instrumentation and experiment orchestration
Closed, ResolvedPublic5 Estimated Story Points

Description

NOTE: SDS 2.4.20: If our documentation explains and shows how to use our suite of tools to conduct experiments, product teams (namely Web) will be able to learn how to instrument, launch, and evaluate their A/B tests themselves using our tools.

Acceptance criteria

  • Documentation includes instructions and a full example for instrumenting an experiment using our new APIs/SDKs such that a product team has enough information to get started with conducting an experiment using Experimentation Lab

Implementation notes

Improve:

Some considerations:

Provide CSS and Javascript guidance that prevents flashing for end users (define treatment name in CSS classes in the string variables)
tell the experiment owner that a logged in user may fall out of the experiment

References:

Event Timeline

mpopov triaged this task as Medium priority.
mpopov set the point value for this task to 3.
mpopov moved this task from Next 2 weeks to Doing on the Product-Analytics (Kanban) board.
mpopov changed the point value for this task from 3 to 5.
mpopov renamed this task from Improve docs on instrumentation and experiment orchestration to SDS 2.4.20: Improve docs on instrumentation and experiment orchestration.May 22 2025, 7:45 PM

Published:

  • A complete revamp of the guide to conducting an experiment covering
    • the whole lifetime of a (web) experiment
    • how to use our brand new JS & PHP SDKs for implementing an experiment (analytics instrumentation and feature toggling)
    • how to configure an experiment in xLab
    • how to evaluate it using our brand new automated analytics MVP
  • A brand new guide to measuring clickthrough rates (CTRs) showing
    • how to think like a product analyst and figure out what CTR means for you and your hypothesis
    • how to use our standard CTR instrument in your instrumentation
    • a mostly-worked-out example of how to instrument baseline data collection AND conduct a simple A/B test on an actual product (namely, Campaigns team's Collaboration list)
mpopov moved this task from Doing to Done on the Product-Analytics (Kanban) board.