Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create docs role handbook #2628

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions release-handbook/doc_roles_handbook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Zowe documentation squad roles

This document covers the responsibilities, time commitments, and basic processes and guidance for different roles within the Zowe Docs team.

## Zowe docs roles

- Zowe Docs Lead
- Zowe Docs Scrum Master
- Zowe Docs Lead Shadows/Co-lead

## Docs Lead Responsibilities

The Docs Lead is responsible for coordinating documentation updates for new Zowe releases, manaing the Zowe docs-site repo, and leading the squad to define documentation roadmap and strategy.

nannanli marked this conversation as resolved.
Show resolved Hide resolved
Responsibilities include:

Task | Where | Time requirements | Resources, comments
---| ---| ---| ---
Monitor Zowe docs-site issues and assign owners | Zowe docs-site GitHub repo | 1-2 hours a week | Looking to automate the process
Monitor Zowe doc-site Pull Requests and assign reviewers | Zowe docs-site GitHub repo | 1 hour a week |
Identify and track new Zowe documentation requests and feedback in other channels like Slack, provide response, and convert into actionable issues | Slack, meetings where invited, emails | Depends, usually 2-3 hours a week | As a squad lead, you'll be the go-to-person whenever people have questions, comments, or ideas about documentation so might get involved in different discussions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Collaboration needed here. Members might have different channels to collect feedback and receive requests, and can work together on the response or actions. And the communicator could be a volunteer or the one who receives the request.

Offer guidance to doc contributors about the doc site process and answer questions | Slack, GitHub repo | On demand, usually <1 hour a week depending on the complexity of help needed | New developers in other squads are also doc contributors. Introduce new contributors to the doc process and empower them with the knowledge needed to get started.
Coordinate release activities for docs, communicate the release schedule, monitor all release tasks to be completed on time | Zowe docs-site repo, Slack | 2-3 hours per release | In general, there's a lot of work in the last week of the release cycle as documentation deadline approaches.
Maintain and optimize documentation processes and update the instructions | Zowe docs-site repo | Depends | Release handbook, maintainer handbook, contributing guidelines, release process, PR review guide, issue triage guide, etc.
Identify overall documentation improvement areas and lead the squad to discuss and take action | / | Depends | For example, overall architectural change that requires squad collaboration and discussion, initiatives from other squads that need doc participation.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Collaboration needed here.

Join Zowe quarterly webinar to present Zowe doc changes | Zowe webinar | On demand | Onboarding squad will contact the lead if there is need for doc squad to join.
Participate in Zowe PI planning, present the squad objectives and bring back feedback | Zowe PI planning sessions | 3 days for each PI | The squad lead also needs to schedule breakout sessions and lead the squad members to discuss and finalize the objectives.

nannanli marked this conversation as resolved.
Show resolved Hide resolved

nannanli marked this conversation as resolved.
Show resolved Hide resolved
nannanli marked this conversation as resolved.
Show resolved Hide resolved
## Docs Scrum Master Responsibilities

Responsibilities include:

Task | Where | Time requirements | Resources, comments
---| ---| ---| ---
Schedule and organize docs meetings | Zoom, OMP Calendar | <1 hour a week | Needs the credentials for the OMP account to be able to record meetings.
Gather agenda items from the squad and run the meeting to lead squad members to go through agenda items | Zoom | 1.1 hour biweekly | Send meeting reminder and actions items after the meeting. Upload recordings or share recording links. Streamline meeting process.
nannanli marked this conversation as resolved.
Show resolved Hide resolved