Skip to content

Provide an explainer #464

Description

@jwrosewell

The TAG design review request for this specification (w3ctag/design-reviews#1229) has no explainer, and the README says the explanation can be found up front in the specification itself.

Wide review is now under way (#425) and invites readers from outside the Working Group. Many of them work in advertising, measurement, policy or law rather than browser engineering. For those readers the specification is unwieldy, and the words it relies on carry different meanings in their fields. Martin Thomson, one of the six editors, described discovering exactly this in a recent public discussion (archived copy) with Alan Chapell. The word attribution meant something different to his readers than it did to him.

An explainer would give every reviewer a common starting point. The following contents would serve wide review best.

  • The problem being solved and for whom.
  • What the API does and does not do. For example, it reports associations between impressions and conversions, and experiments remain necessary
    to measure causal effect (Limitations section #441).
  • The terms it relies on and what they mean here, starting with attribution itself.
  • The parties involved and what each one can see, websites, intermediaries, browsers and aggregation services.
  • The alternatives that were considered and the reasons this design was chosen.
  • Known limitations.

Some of this information also belongs with the review request itself. The TAG's request template has fields for previous reviews, for major unresolved issues or opposition, and for the alternatives considered. In the filed request the first is answered "N/A", although the TAG reviewed the predecessor proposals IPA (w3ctag/design-reviews#823) and the Attribution Reporting API (w3ctag/design-reviews#724), and the other two are unanswered. Whether this information sits in the explainer or in the review request documents, reviewers arrive better informed with it than without it.

The following material is already public and would help any reviewer, whether referenced from the explainer, the review request or both.

A first draft could be produced quickly from the specification and the group's discussions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussNeeds working group discussion

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions