Improve docs experience for Experience Baseline JTBD: Create a merge request (Template, Labels, Milestones, Assignees)
As part of the FY20-Q4 documentation OKR gitlab-design#692 (closed), this issue pertains to a "job to be done" (JTBD) in GitLab--"Create a Merge Request (Template, Labels, Milestones, Assignees)"--which has been evaluated by UX as part of an Experience Baseline Review.
If you are working on this issue, review the linked OKR and the Experience Baseline Recommendations Handbook page for more detail. Then review the links below, per the OKR instructions.
UX Evaluation issue - gitlab-design#441 (closed)
UX Evaluation video - https://youtu.be/WOdqw_z2dwE
UX recommendations issue - gitlab-design#444 (closed)
Potential doc work -
Technical writer - @marcel.amirault
Product designer -
Based on the steps in the OKR epic, use the checkboxes to indicate when each step is complete, and use the format below for notes and plans. You are welcome to alternatively link any/all subsections to an additional issue or a Google doc, to work there instead.
-
Review existing info -
Review SEO -
Document and improve SEO
-
-
Consider potential UI doc link -
Review and improve documentation content -
Test the instructions -
Plan documentation improvements/additions -
Ask questions of and share plans with Product Designer -
Implement doc changes
-
Plans & Notes
1. Review existing info
When checking the docs, the topic with the biggest weakness is Labels, which has too many large screenshots, is unclear and just plain confusing at times. It needs a full revamp.
2. Review SEO
Finding sections seems OK with search, but any weakness seems more related to Algolia, and not the page.
a. Document and improve SEO
Some simplified section headings may improve searching slightly.
3. Consider potential UI doc link
UI links already exist for Labels, which are acceptable.
- Verified that no UI anchors were affected by the revamp.
4. Review and improve documentation content
a. Test the instructions
b. Plan documentation improvements/additions
- Needs a full copy edit to simplify and clarify almost everything.
- Needs a full restructure to group things together logically.
- Far too many large screenshots. With better text, we can drop many of these.
See MR description for full details.
c. Ask questions of and share plans with Product Designer
d. Implement doc changes
Implemented in:
Related to gitlab-design#692 (closed)