The UX Guide documents our principles, approach, and perspective to the experience of GitLab. Help keep this document up to date and correct by creating merge requests.
The vision of GitLab is far from finished and there are a lot of emergent properties that will allow us to simplify. We believe in iterative improvements and value aggressive change. We will get some things wrong and quickly strive to make them right. We have a long way to go, that is why we are taking big steps.
Before committing to issues, check if another UX Designer has already participated. If their latest activity on that issue was within two months and you’d still like to work on it, ask them what the status is and if you can pick it up for them. If their latest activity on that issue was more than two months ago, just let them know that you’ll be picking it up for them.
Define the scope:
UX issues have a tendency to expand in scope. Aggressively split off new issues, ideas, and concepts into their own issues. Large issues become really challenging to drive decisions in and make progress on. If you’re ever unsure how to split apart large issues, work with the UX Lead.
Developers should be able to ship a product within one life cycle. If a feature is too large to ship within one release, work together to determine the best way of splitting the feature into smaller segments.
Bring developers into the conversation early. Ask for feedback on how to split up features while still maintaining the integrity of the UX.
When breaking up features into smaller parts, make sure that the end design goal is known. Giving the team the full picture will help developers write code aimed at achieving that goal in the future.
Keep the issue description updated with the agreed scope, even if doesn’t impact your work. This is everyone’s responsibility. The issue description must be the Single Source Of Truth (SSOT), not the discussion or individual comments.
Add comments with your proposals. Propose one solution, not multiple alternative solutions for others to pick, as this undermines your position as a UX expert and leads to a design by committee situation. If you have a good reason to propose multiple alternative solutions make sure to explain why.
Anticipate questions that others might have and try to answer them in your proposal comments. You don’t have to explain everything, but try to communicate a bit of your rationale every time you propose something. This is particularly important when proposing changes or challenging the status quo. This reduces the feedback loop and time spent on unnecessary discussions while contributing to the credibility of the UX team, who deal with a lot of seemingly subjective issues.
Keep the SSOT updated with what’s already agreed upon so that everyone can know where to look. This includes images or links to your design work.
If you’re working with design files, follow the instructions in the GitLab Design project and regularly commit them.
If you are proposing a solution that will introduce a new UX paradigm, or change an existing one, there are additional steps to follow. See the 'Maintain' section below for those steps.
Once your work is complete, make sure that the SSOT is updated. This is where you should direct people when they have questions about what should be done and how.
If applicable, commit all design assets and files according to the instructions in the GitLab Design project.
Once UX work is completed and all feedback is addressed, remove the UX label, add the UX ready label, and:
If the issue is scheduled for a milestone, add the next workflow label needed to progress the issue. Typically, this is the frontend label.
Keep the SSOT in the description updated until the issue is closed. This applies to both text and mockups. Previous content (by a PM, for example) should be removed or archived into a separate section in the description. If the developer working on the issue ever has any questions on what they should implement, they can ask the designer to update the issue description with the design.
When any of those requests are merged, add an agenda item to the next UX weekly call to inform everyone of those changes.
How do I raise a research request for the UX researcher?
Within the CE or EE project, raise a new issue using the research template.
Add the labels backlog and UX Research to the issue.
@ mention Sarah O'Donnell @sarahod
Sarah will schedule the work accordingly.
What is the UX researcher workflow?
Work with the UX team to determine what should be researched.
Create a meta issue within the UX research project.
Label the meta issue with the area of GitLab you’re testing (for example, navigation) and the status of the issue (in progress).
Mark the meta issue as confidential until the research is completed so it doesn’t influence user behavior.
Conduct the research.
Document the findings and recommendations within the meta issue.
Unmark the meta issue within the UX research project as confidential.
Update the status of the meta issue to done.
Within the meta issue, encourage discussion between yourself, UX designers and product owners about which findings should be turned into issues within the GitLab CE or EE project.
Create the agreed, new issues within the GitLab CE or EE project. If relevant issues already exist, add your findings to the existing issue descriptions. Always link your comments back to the meta issue within the UX Research project.