FY24Q1 TW KR: Write or refine tutorial topics for high-impact areas of the GitLab product => 82%
In a previous OKR, we identified new tutorial topics for high-impact areas of the GitLab product.
For the next iteration, we plan to:
- Write new, or refine existing, tutorial topics for high-impact areas of the GitLab product, and add them to the Learn GitLab with Tutorials page. (TW team)
- If you have not yet identified a tutorial topic, do that first, following the steps in FY23Q4 TW OKR: Expand "Learn GitLab with Tutor... (#701 - closed). Then, as a stretch goal, write or refine the tutorial.
Draft a tutorial topic
Technical writers are responsible for writing and drafting the tutorial topic for this KR. You'll need a technical review from minimally a developer or PM, and a technical writing review from @kpaizee
.
You only need to write one tutorial for this quarter.
- Give your technical reviewers an early heads up that you'll need their input for a review.
- Review our style guide on tutorials, and examples that we already have in the docs.
- Tutorial page type
- Examples:
- Tutorial: Make your first Git commit
- Tutorial: Use GitLab to run an Agile iteration
- Tutorial: Move your personal project to a group
- Optional. Explore other examples by searching for
Tutorial:
.
- Add a draft "working title" of the tutorial to the table below.
- Create a draft MR for technical review.
- Once the technical review is complete, request a Technical Writing review from
@kpaizee
, remove the DRAFT status. - Get help at any point by mentioning
@kpaizee
,@sselhorn
, or@dianalogan
. The tutorial does not have to be perfect, you can iterate after it's merged. - Once the tutorial MR is merged, open an MR for a left nav entry.
- Add a link to the tutorial on the Learn GitLab with tutorials landing page.
Completed tasks
- Amy
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Ashraf
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Axil
-
Issue created and added to tutorials epic.
-
- Catherine
-
Issue created and added to tutorials epic.
-
- Evan
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Fiona
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Lorena
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Jon
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Marcel
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Marcin
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Phillip
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
- Russell
-
Reviewed docs guidelines and examples -
Added working title to table -
First draft in technical review -
MVC tutorial merged, left nav updated -
Added to Learn GitLab page (or considered)
-
Edited by Fiona Neill