Expand list of UI text items and add link
Why is this change being made?
MVC in response to research and recommendations carried out in Q1 by Craig and the Technical Writing team on best practices for working with Product Designers on UI text.
Related issues
- Q1FY23 KR - Research team best practices for working with Product Designers on UI text
- Recommendations based on TW/Product Designer interaction research
From the Recommendations issue, this MR addresses:
Better define and document the literal items Technical Writers can provide assistance to the Product Designers about (this can be included in the Partnering with Technical Writers section of the Product Designer Workflow), both for creation and review:
- UI text
- Messages (errors/warnings/status, in the application and in logging)
- Notification emails
Author Checklist
-
Provided a concise title for this Merge Request (MR) -
Added a description to this MR explaining the reasons for the proposed change, per say why, not just what - Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
-
Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI) - If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
Maintained bysection on the page being edited - If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
- If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
-
If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR - If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.