Transition Monitor/Respond TW assignment to docs channel
- Stage/group being transitioned: devopsmonitor grouprespond
- Current technical writer: @msedlakjakubowski
- Incoming technical writer: docs channel
- Reassignment milestone: 16.5
Related issues/MRs: https://gitlab.com/gitlab-org/technical-writing/-/issues/918
Tasks for current technical writer
Section not applicable for transition to docs channel.
-
Invite the incoming TW to the stage and group Slack channels.- Channel list: TBD
-
Post in Slack about the changeover. Communicate the timeline and how MRs will be handled. -
Reach out to the Product Manager, Engineering Manager, and Design Manager to communicate the change.-
PM: TBD -
EM: TBD -
PDM: TBD
-
Group information for incoming technical writer
To make the transition easier for the incoming technical writer, answer these questions in separate comments threads. Give as much detail as you feel is needed. The incoming technical writer should feel free to ask questions about any of these details:
-
How does the Product Manager plan work for future milestones? Provide links to relevant boards. -
How does the group prefer to communicate in issues and MRs regarding reviews? -
What is the maturity of the feature set and documentation for the feature set? -
How well are features of the group known to people outside the group? -
How much UI text work does the group generate? -
Can the feature set for the group be explored solely on GitLab.com, or does it also require GDK or access to third-party tools? -
Does the group attract a lot of Support Team Contributions and Community contribution?
Tasks for EMs and PMs
-
Add the incoming TW to team meetings and any group aliases.- Meeting list: TBD
-
Remove the outgoing TW from team meetings and any group aliases. -
Determine the resources needed by the incoming TW to learn the stage / group features, similar to an engineer's onboarding.
Tasks for incoming technical writer
-
Set up coffee chats with the group's:-
Product manager -
Engineering manager -
Frontend and backend team members (not necessary to meet all) -
UX designer
-
-
Read the product documentation associated with your group (as identified by the group attribute in documentation pages' metadata). -
In the
www-gitlab-com
repository, update:-
data/stages.yml
, with your new assignment. If you're onboarding as a new Technical Writer, you can wait until you've completed a full release cycle as a trainee before doing this step and the next steps.MR: Remove Marcin as Respond TW (gitlab-com/www-gitlab-com!129837 - merged)
-
-
In the
gitlab
repository, update as needed (in the following order, but can be done in the same MR):-
The metadata in all related markdown files (if the group name changed). -
Group assignments in lib/tasks/gitlab/tw/codeowners.rake
. -
.gitlab/CODEOWNERS
by running thetw:codeowners
Rake task to ensure no pages are missed.
-
Tasks for technical writing manager
-
Update Workday with the new group assignments. Workday updates the group assignments in data/team_members/person
. Interim instructions during Workday rollout: Manager emailspeople-connect@gitlab.com
with details of changes.