Skip to content

Explainer Horizontal Review Checklist Proposal #21

@lolaodelola

Description

@lolaodelola

This is a proposal for the checklist/rubric we can use to check explainers against, if we choose to move forward with this.

  • Section completeness
    • Introduction
    • User-facing problem
    • Use cases
    • Non-goals
    • User research
    • Proposed approach
    • Alternatives considered
    • Accessibility considerations
    • Privacy and security considerations
  • Code examples:
    • Are they syntactically correct (at least plausible JS)?
    • Do they illustrate use cases, not just API shape?
  • Diagrams properly labelled (alt-text or caption)
  • Links point to correct locations
  • First time reader accessibility, i.e. can someone outside of the space understand what is being proposed and why?**

** I'd particularly like to discuss this, as it stands I think most specs would fail this and that might be ok?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions