[go: up one dir, main page]

Page MenuHomePhabricator

Governance & Guidelines: Design System Component Creation Guidelines v1
Closed, ResolvedPublic

Description

Background/Goal

Create and publish Design System Component Creation Guidelines v1.

User stories
  • As a front-end development team, we need know how to contribute NEW components to the design system.
Considerations
  • This is a sub-section under overall component management, so we can eventually link up as needed
  • We have already developed a process for scoping out and implementing new components that the DST team has been following. We should leverage that and make sure it meets the requirements and acceptance criteria.
Requirements

The Component Creation Guidelines MUST include the following:

    • Workflow description
    • Workflow roles and responsibilities (who is doing what, when, and why)
    • Clear set of steps and/or checklist
  • There is a single source of truth for each user story (aka artifact)
  • All source of truth documents/artifacts are available via Design System Portal/Wiki
Acceptance criteria
  • There is a single source of truth for each user story (aka document)
  • All documentation should link back to a central Design System Portal/Wiki
  • Artifacts should be:
    • easy to read (limited jargon)
    • clear to follow (written as steps, checklists, visual diagrams, etc.)
  • Ambiguity in who does what should be mitigated
  • Access to artifacts should NOT be restricted for viewing by target users (aka remove or update permissions as necessary)
Test scenarios

[N/A]

Open questions

[N/A]