Q3FY22 KR: Improve the UX of Settings pages by finalizing UI text
Part of the FY22-Q3 UX Department OKRs.
The UI text on GitLab Settings pages needs to be reviewed and edited for wordiness, passive voice, inconsistency, clarity, and future tense.
The GitLab application is based on the Pajamas UI text guidance voice and tone requirements. Familiarize yourself with the guidelines in the Content section of Pajamas.
Field names, button names, or other UI element labels shouldn't be changed unless their current state causes significant product use issues. Be sure to update product documentation if UI elements change in this manner.
Background
- Every Technical Writer will review UI text for the Settings sections listed in this issue. The Settings are drawn from the Projects, Groups, and Admin Area, including the unfinished Project Settings from the FY22-Q1 OKR issue.
- After completing their review, Technical Writers will make relevant updates to their assigned sections' wording within the code.
- Issues will have been created for each Settings section that needs a review by the time of the review.
OKR Process
- TWs should self-assign enough issues to complete the effort this quarter (3 to 5).
- Use the UI-text template in the Technical Writing project.
- Assign yourself to the issue created for the section you're working on, and add your name to the following table for that section.
- Two TWs will do a holistic review of the Settings UI text, ensuring that changes over successive quarters work, and that the wording across different UI sections works as a collective whole throughout the application.
Remaining issues for work - TW tracking section
Here's the list of remaining Settings UI work. If you're working on one of these, be sure to add your name and the issue to the appropriate line. When you're done, select its checkbox. We'll be moving these lines to other issues for tracking in Ally, so if an item you completed "disappears," it's just moved over to one of the tracking issues.
(Tracked in Diana's and Craig's issues below, not this list.)
Group > General > Advanced - @marcia (gitlab#330162 (closed)) Group > Webhooks > Top-level page - @marcia (gitlab#330171 (closed)) Group > Applications > Top-level page - @fneill (gitlab#330174 (closed)) Admin Area > General > Visibility and access controls - unassigned (gitlab#330180 (closed)) Admin Area > General > External authentication - unassigned (gitlab#330186 (closed)) Admin Area > General > Amazon EKS - unassigned (gitlab#330198 (closed)) Admin Area > Advanced Search > Top-level page - @marcia (gitlab#330207 (closed)) Admin Area > Network > Outbound requests - unassigned (gitlab#330223 (closed))
Ally tracking issues
TWs do not need to do anything with these issues. These are just for tracking our overall Settings UI work in Ally. Only Diana and Craig will modify these issues.
-
Settings and review work (EMEA) - @dianalogan (#456 (closed)) -
Settings and review work (AMER/APAC) - @cnorris (#457 (closed))