Improve docs experience for Experience Baseline JTBD: Create a merge request (Approval rules & Changing branches)
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 (Approval rules & Changing branches)"--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 reviewing the docs, it was very clear that approvals documentation is sub-par and confusing. I did not dig into changing branches as the approval rules was a large enough issue as it is.
2. Review SEO
Better section headers may help with searching.
a. Document and improve SEO
3. Consider potential UI doc link
- Verify that current docs links are not broken.
- Two were broken, now fixed in !23948 (merged)
4. Review and improve documentation content
a. Test the instructions
b. Plan documentation improvements/additions
- Complete overhaul needed. Restructure, simplification, screenshot analysis, etc...
- Section reordering, renaming, and regrouping is at the top of the list of changes.
See MR description for full details.
c. Ask questions of and share plans with Product Designer
d. Implement doc changes
Implemented in:
Related to !23861 (merged)
Related to gitlab-design#692 (closed)