FY21-Q1 OKR: Audit and improve 10 high-traffic areas of the GitLab Documentation
The following are instructions for each technical writer at GitLab to follow for this OKR.
1. **Identify the single [highest traffic page](https://docs.google.com/spreadsheets/d/1BOYBsfQ1hcspEicrN-kfKYfQcErOLyjl6Yy75MRAE0Q/)** among those corresponding to your stage/groups (per FY20-Q4 Total Time on Page (Pageviews x Avg. Time On Page)). These are already listed as defaults in the table.
1. Determine if it's better to only review and improve the *single page* (for example, if it primarily stands alone and is relatively long) or if it's best to review/improve it *among a group of pages* (e.g. shorter adjacent pages in a subdirectory that heavily cross-link). Request manager review/approval of your justification for this either way, or to make the case for swapping in an entirely different page or section for review. Once confirmed, work with your group to quickly schedule SME commitments.
1. **Technical review** - ensure the doc(s) are factually accurate by confirming information yourself and partnering with an SME where helpful or necessary. Revise as needed.
1. **Review and edit** for structure, style, quality and completeness: Ensure that introductory material is present; titles, headings, and subheadings are meaningful and helpful; there are links to more fundamental/background information; etc. Ensure the docs are in line with the GitLab Style guide.
1. Obtain and utilize Product Manager feedback on page title and feature naming considerations, contextual/introductory content, and the TOC tree (headings/structure). Beyond this, PM review of the entirety of your plans or edits is optional, so long as another SME is involved, but the PM should be aware of the work happening.
The sequence of the above reviews can vary depending on the content and the availability of PMs and other SMEs such as engineers.
| Title | Stage | Group | Tech Writer | Issue |
|:-------------------------------------------------------------------------------------------------------------------|:-------------------|:-----------------------|:-------------------|:-----------------------------------------------------|
| [GitLab CI/CD Pipeline Configuration Reference](https://docs.gitlab.com/ee/ci/yaml/index.html) | Verify | Continuous Integration | @marcel.amirault | https://gitlab.com/gitlab-org/gitlab/-/issues/205397 |
| [Start using Git on the command line](https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html) | Create | Source Code | @marcia | https://gitlab.com/gitlab-org/gitlab/-/issues/212870 |
| [GitLab and SSH keys](https://docs.gitlab.com/ee/ssh/index.html) | Manage | Access | @mjang1 | https://gitlab.com/gitlab-org/gitlab/-/issues/207167 |
| [GitLab Docker images](https://docs.gitlab.com/omnibus/docker/index.html) | Enablement | Distribution | @axil | https://gitlab.com/gitlab-org/gitlab/-/issues/207892 |
| [GitLab Markdown](https://docs.gitlab.com/ee/user/markdown.html) | Plan | N/A | @msedlakjakubowski | gitlab-org/gitlab#205689 |
| [Backing up and restoring GitLab](https://docs.gitlab.com/ee/raketasks/backup_restore.html) | Enablement | Geo | @eread | https://gitlab.com/gitlab-org/gitlab/-/issues/207893 |
| [Jenkins CI service](https://docs.gitlab.com/ee/integration/jenkins.html) | Enablement | Ecosystem | @rdickenson | https://gitlab.com/gitlab-org/gitlab/-/issues/206915 |
| [Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/index.html) | Secure | Static Analysis | @ngaskill | https://gitlab.com/gitlab-org/gitlab/-/issues/207165 |
| [Auto DevOps](https://docs.gitlab.com/ee/topics/autodevops/) * | Configure | Configure | @aqualls |https://gitlab.com/gitlab-org/gitlab/-/issues/212872 |
| [Creating and using CI/CD pipelines](https://docs.gitlab.com/ee/ci/pipelines.html) | Verify | Continuous Integration | @sselhorn | https://gitlab.com/gitlab-org/gitlab/issues/205174 |
\* These stages' top pages have lower traffic than the others, so please consider your stage's content and whether you'd suggest an audit there vs. a higher-traffic area of another stage and discuss with your manager.
epic