Page MenuHomePhabricator

Design a flowchart to explain when to use Codex / OOUI / Other Figma libraries
Closed, DeclinedPublic

Description

Background/Goal

Requirements for this task collected from this comment in T306874 and this Slack thread.

Following to the conversation during out last design system office hour on Codex vs. OOUI, I rewatched the recording, and I was wondering if it might be helpful to have a flowchart somewhere (image below as an example) to help us navigate through this transition. In our case could be something like:

  • Are you designing for Abstract or Growth? [Yes][No].
    • If [Yes], use Codex Figma Library.
    • If [No], use OOUI Figma library.
      • Do you need a component that is available in Codex? [Yes][No]
        • If [Yes], copy and paste it in your file and let engineers know that is not available in OOUI therefore provide the specs to implement it in the local project.
        • If [No], …

Captura de Pantalla 2022-10-26 a las 11.17.55.png (1×2 px, 1 MB)

User stories

  • As a designer I need to understand when to design with the OOUI components.
  • As a designer I need to understand when to design with the Codex components.
  • As a designer I need to understand which tokens should I use in my designs.
  • As a designer I need to understand which assets should I use in my designs.

Acceptance criteria (or Done)

  • Design a flowchart to explain all use cases described in the user stories section
  • Add this flowchart in a place where designers can easily find it when designing

Event Timeline

bmartinezcalvo renamed this task from Design a flowchart to explain when to use the OOUI or the Codex Figma library to Design a flowchart to explain when to use OOUI / Codex / Other Figma libraries.Oct 26 2022, 9:25 AM

This task has some overlap with T289208: Develop and document a proposal for when to use Vue/Codex, which came out of T279421: Update Vue and Codex documentation for WMF staff and community developers.

I think that this goes beyond just documentation – DST (and WMF Product more generally) needs to provide some clear guidelines on what approach should be used to develop user interfaces in various scenarios. It should not be left to the preferences of individual teams or contributors. Instead the decision should be based on the use-case, technical requirements, and availability of necessary components.

Once T321351: [EPIC] Add CSS-only components is complete, I believe we should discourage any new projects from using OOUI. If Codex is not sufficient for the needs of a particular team at that point, DST should try to help bridge the gap. The main exception to this rule in my mind would be anything to do with VisualEditor; that feature will remain OOUI-based for the forseeable future.

ldelench_wmf moved this task from Needs Refinement to Backlog on the Design-System-Team board.
ldelench_wmf subscribed.

Setting as low priority; based on @egardner's comment above I'm guessing we won't get to this until next quarter. Feel free to edit!

Volker_E renamed this task from Design a flowchart to explain when to use OOUI / Codex / Other Figma libraries to Design a flowchart to explain when to use Codex / OOUI / Other Figma libraries.Jan 22 2024, 5:56 PM
bmartinezcalvo added a subscriber: CCiufo-WMF.

I think we no longer need to work on this task since the use of each library is clear. @CCiufo-WMF declining it for now, feel free to reopen if you think it's necessary.