Skip to content

FY22-Q2 Technical Writing KR-2: Review and refactor UI text on Project/Group/Admin Area Settings pages => 41/77, 53%

Part of the FY22-Q2 UX Department OKRs.

Q3 issue: #452 (closed)

The UI text on GitLab Settings pages needs to be reviewed and edited for wordiness, passive voice, inconsistency, and future tense. Are the field descriptions clear? You may discover other issues to fix as well.

First, we will use the Pajamas UI text guidance voice and tone requirements. Familiarize yourself with the guidelines in the entire "Content" section of Pajamas.

We will not change field names or button names unless they're egregious, because we'd also have to then go fix the doc.

Current tally (as of July 29): 41 completed issues out of 77 (53% of total)

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 at least 6 issues throughout the quarter.
  • 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.

Settings to do

Links and references

We are tackling a subset of all GitLab Settings pages. The complete list is here:

Edited by Marcel Amirault