Skip to content

Technical Writing milestone plan for 15.5

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 OKRs and other tasks that are not reflected in this issue.

On the 15th of each month:

The TW Bot creates the issue for the upcoming milestone.

By the 29th of each month:

The TW carries out planning activities for their assigned groups, and populates Checklist and links to confirm these activities have taken place:

  1. 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). This is also an opportunity to talk to the PM or EM about any improvement or development opportunities they're aware of in their areas of the product documentation. 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.

  2. 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)

  3. 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.

Stage devopsmanage

Stage devopsplan

Stage devopscreate

Stage ~"devops::ecosystem"

Stage devopsverify

Stage devopspackage

Stage ~"devops::release"

Stage ~"devops::configure"

Stage devopsmonitor

Stage devopssecure

Stage devopsgovern

Stage ~"devops::analytics"

Stage devopsgrowth

Stage devopsfulfillment

Stage devopssystems

Stage ~devops::data_stores

Stage devopsanti-abuse

Other 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

Coverage

TW recurring tasks

TW team KRs

Docs-only backlog by stage

** Informational only this milestone **

  • New issue board showing recent (through 2021) docs-only backlog issues by stage.

  • Activities we're considering for next milestone/quarter:

    • Review issues on your "personal" backlogs for correct labels.
    • Review pre-2021 issues for closure/correct labels.
Edited by Clayton Cornell