Uploaded image for project: 'PUBLIC - Liferay Commerce'
  1. PUBLIC - Liferay Commerce
  2. COMMERCE-4733

Create Commerce design documentation

    Details

    • Type: Task
    • Status: In Review
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Business Value (single choice):
      1

      Description

      Background

      Over time, we've create rules and patterns for how Liferay Commerce is designed. For example, there are rules for when we use a modal vs. slide-out sidebar vs. new screen. We have developed internal names for different elements on a page.

      These are patterns that are unique to Commerce and not documented in a guide like Lexicon.

      In order to 1) make our future selves' lives easier, and 2) improve our ability to communicate with each other more easily, and 3) help to scale out our design team in the future, it would be very helpful to have documentation on these patterns.

      Definition of Done

      1. Document
        1. Taxonomy: give names to components, like what we name the slide-out side bar, the header, etc.
        2. Patterns: what common patterns exist and what rules surround those patterns
      2. Format
        1. I don't have a strong opinion on the format. Maybe Ryan Connolly has some advice on how to format it and where to store it.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              corbin.murakami Corbin Murakami
              Reporter:
              corbin.murakami Corbin Murakami
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Packages

                  Version Package