Heuristic evaluation of .gitlab-ci.yml keyword reference page
Problem
The gitlab-ci.yml keyword reference page is one of the most frequently accessed pages on the docs site.
We have many suggestions for improving the page. I would like a design expert to identify problems in organization, readability, and scannability on this page, and make suggestions for MVC and longer-term fixes.
Evaluation scenarios
Some potential scenarios we could use during the eval include (thanks, @marcel.amirault):
- Users who maintain their pipeline config, are familiar with GitLab CI/CD, and looking up reference info for a specific keyword (that they already know about) to help with updating pipeline configuration. From the search console results, I think this is the most common. Similar to folks looking at our API references.
- Users who maintain pipeline config (like above), but who are not sure which keyword to use, and are searching based on the task they want to do, not any specific keyword.
- Users who maintain pipeline config (like above), but who are looking at the reference for help troubleshoot failing pipelines.
- Users who are familiar with competitor CI/CD products (like Jenkins, Circle CI, GitHub Actions), and are checking the reference to learn about GitLab's implementation (perhaps to migrate to GitLab CI/CD).
- Users who are not familiar with CI/CD at all, and looking at the reference to learn about it (I'd suggest they are on the wrong page, but I'm sure people can land on this page by accident, despite the improved search).
Actions
-
Search past research findings in GitLab and Dovetail that mention this page by name or URL
Edited by Pedro Moreira da Silva