Provide guidelines for the usage of Drawers for consistent presentation of in-product Help information

Description

Among other things, Drawers are used to present in-product contextual help information in GitLab. We need to provide guidelines for the usage of Drawers for Help information specifically to ensure consistent experience and a certain standard for the formatting and presentation of help info.

Questions to consider

  • What are the nuances of using a Drawer for Help information? How can we standardize the design of Help drawers in GitLab?
  • What kind of content does / does not belong in the drawer?
  • What is the order of types of content?
  • Where does the content reside for best updating? Right now, it is hardcoded in the product.
  • Requirement for TW to be involved in the Help window content creation (this type of content shouldn't extensively duplicate what is already available (potentially - need to think about this one); should not consist of mostly links; should answer very specific targeted questions, should follow our CTRT design guidelines). For example - the types of content in the CI/CD example are concept, task, tip, reference. Great content and the order is helpful.

Checklist

Make sure the following are completed before closing the issue:

  1. Assign the correct component label to this issue.
  2. Create an MR with the additions or updates needed.
  3. When applicable, create a new Pajamas issue using the "Figma update" issue template to update the component in Figma. Bring the issue to your team planning session for prioritization and scheduling. Mark the issue as related to this one.
  4. When applicable, create an MR in GitLab UI to update the component. If you do not have capacity or are unable to update the component directly, create a new GitLab UI issue using the "Component" issue template. Bring the issue to your team planning session for prioritization and scheduling. Mark the issue as related to this one.
  5. When introducing a major or breaking change, communicate the changes within the Engineering Week in Review and UX Weekly meeting.
  6. 🎉 Congrats, you made it! You can now close this issue.
Edited by Nadia Sotnikova