Technical Writing milestone plan for 16.11
This issue provides a consolidated view of what the Technical Writing team expects to work on with their assigned groups for the upcoming milestone. In addition to the work with their assigned groups, the Technical Writing team also works on other tasks that are not reflected in this issue.
On the 1st
of each month:
The TW Bot creates the issue for the upcoming milestone using a scheduled pipeline.
We open this issue on the 1st to align with planning activities carried out by other teams and stakeholders. The 1st is on or around 12 days before the milestone begins. For example, for 16.8 (2024-01-17), the milestone starts on 2023-12-16 and we open this issue on 2023-12-01. For more information, see the product development timeline.
By the start of the milestone:
The TW carries out planning activities for their assigned groups, and populates Checklist and links to confirm these activities have taken place:
-
Have a conversation - synchronously or asynchronously - with either the group PM or EM to review:
- Planned documentation and UI text work for the upcoming milestone (
Milestone: Upcoming
) or (Milestone: Started
). - Improvement or development opportunities they're aware of in their areas of the product documentation.
- If any deprecations can be announced according to the process for deprecating and removing a feature. Deprecations should be announced as soon as possible, but the group should have a firm idea of deprecated features from about half-way through a major release cycle.
This can be a regular group meeting or any other means of communication that you have established with your group.
If the TW, PM, or EM is unavailable around the beginning of the milestone, we encourage using async methods (like commenting in issues or Slack messages) or having conversations at an earlier time. If the conversation happens before the creation of the issue, just add the planning information to the issue when it's available.
- Planned documentation and UI text work for the upcoming milestone (
-
Identify a linked artifact that describes the upcoming planned work, such as:
- An issue board for the group's documentation/UI text items for the milestone.
- A filter that describes/lists the planned work. (Example for devopsplan)
- The group's planning issue, if it identifies issues/MRs that require Technical Writing team involvement. (Example)
-
Select the appropriate checkboxes and share the links to planned features to confirm that the "conversation" has taken place.
Checklist and links
After you've reviewed the plan with your PM or EM, select the checkbox for your group. If you can't meet with the PM or EM for some reason (perhaps they're on PTO), append that information to the end of the line and leave the checkbox cleared.
devopsmanage
Stage-
groupimport and integrate - issue -
groupfoundations - Link to board or filter
devopsplan
Stage-
groupproject management - board | planning issue -
groupproduct planning - board | planning issue -
groupoptimize - board, issue
devopscreate
Stage-
groupcode creation - Planning board -
groupcode review - board, Code Review 16.11 Planning : March (create-stage#13190 - closed), Code Review Product Design 16.11 Planning (create-stage#13192 - closed) -
groupeditor extensions - board, Editor Extensions 16.11 Planning (gitlab-org/editor-extensions/meta#74 - closed) -
groupide - issue -
groupsource code - board, planning issue
devopsverify
Stage-
grouppipeline authoring - Board -
grouppipeline execution - Board -
grouppipeline security - Board -
grouprunner - Link to board or filter
-
~"group::runner saas" - Link to board or filter
devopspackage
Stage-
grouppackage registry - Link to board or filter
-
groupcontainer registry - Issue
devopsdeploy
Stage-
groupenvironments - Link to board or filter
devopsmonitor
Stage-
groupanalytics instrumentation - Link to board or filter
-
groupproduct analytics - board, issue
devopssecure
Stage-
groupstatic analysis - Planning issue -
groupsecret detection - Planning issue -
groupdynamic analysis - Planning issue -
groupcomposition analysis - Planning issue -
groupvulnerability research - Link to board or filter
devopsgovern
Stage-
groupsecurity policies - Planning issue - SP have decided to carry over the planning issue from %16.11. -
groupthreat insights - Planning issue -
groupcompliance - gitlab-org/govern/compliance/general#202 (closed) -
groupanti-abuse - Link to board or filter
-
groupauthentication - Planning board -
groupauthorization - Planning board
devopsfulfillment
StageAll Fulfillment groups: board
-
groupprovision - Link to board or filter
-
grouputilization - Link to board or filter
devopssystems
Stage-
group::distributionbuild / group::distributiondeploy - issue board -
groupgeo - gitlab-org/geo-team/discussions#5111 (closed) -
groupgitaly - gitlab-org/gitaly-planning/release-planning#21 (closed)
devopsdata stores
Stagedevopsplatforms
StageOther events and team efforts this milestone
-
Managers (@kpaizee, @dianalogan) check the Developer Evangelism calendar for Hackathons and other events that may impact team velocity this milestone. List the events and dates, and let the team know in the tw-team
Slack channel, and as a read-only in the TW Team meeting.
Events
Link to events and team efforts (hackathons, other events).
✂ UX Paper Cuts
Epic that links to UX Paper Cuts team planning issue for this milestone. Issues and MRs have regular stage/group labels.
TW recurring tasks
- Release Post structural check for 16.11: @eread
- Monthly doc version release on April 18: @lciutacu
- Docs project maintenance tasks:
- Review docs-only backlog issues
TW team KRs
Other team KRs
List of KRs from other teams with Technical Writing impact or involvement this quarter:
Stage and group | TW | KR |
---|---|---|
All | All | Support team initiative to clean up old version references in docs. Will send MRs to TWs for review (per group). |
stage and group label |
TW name |
link to KR |
stage and group label |
TW name |
link to KR |
Docs site work
- Issue board (ongoing work)