Q3FY2022 KR: Make it easier to navigate the product by applying consistent language to user docs
On docs.gitlab.com, we are inconsistent in how we refer to basic navigation. By standardizing this language, which is widespread, we will make the docs easier to scan and digest.
For example:
- We refer to projects and groups differently. (From the group, Go to the group, In your group, At the group level, etc.)
- We use different intro words (On the menu, From the menu, In the menu).
- We use different words for different UI elements (From the sidebar, On the top bar, etc.)
- We use different verbs (Navigate, Go, Visit).
- We use different nouns and descriptors (expand the blah section vs. expand blah, click the blah button vs. click blah).
- We use different combinations of steps. Sometimes we combine them (Go here and click this.) and sometimes we separate them (Go here. Click this.).
Full file list is here: https://docs.google.com/spreadsheets/d/1csiUcRmt-YK8Bjp6MvSw-0xZhkK6Os6GYepLLftzrm8/edit?usp=sharing
There are 380 topics in the nav under Use GitLab. In this OKR I will target half (190).
Deliverable for the OKR:
-
Define standards for how we write about navigation in the UI. -
Update the style guide with clear standards. -
Review 50 pages and implement the standards. -
Review 50 more pages and implement the standards (100 total). -
Review 50 more pages and implement the standards (150 total). -
Review 40 more pages and implement the standards (190 total).
Edited by Suzanne Selhorn