Skip to content

Add a "docs feedback or ideas" section to TW page

Amy Quallsrequested to merge
aqualls-how-to-get-docs-help into main

Why is this change being made?

Adds a section to https://handbook.gitlab.com/handbook/product/ux/technical-writing/ to clearly state the process for contributing both merge requests and issues regarding documentation.

(It's currently a stub, so we can discuss it.)

As part of my stage lead work for Q1 I've been trying to establish feedback loops in some teams, like solutions architects, that have information we could potentially publish in the docs. In my conversation with Jason Morgan (@rjmo), he pointed out that we needed to state two processes clearly and quickly on our team page:

  • when a team member finds a docs problem and knows how to fix it (make a merge request)
  • when a team member has an idea for a docs improvement, but can't provide an immediate fix (make an issue)

Related

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct
    • The when to get approval handbook section explains when DRI approval is required
    • The who can approve handbook section explains how to identify the DRI
    • If the MR does not require DRI approval, consider asking someone on your team, such as your manager.
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Division: If the update affects your division, share the MR in your division Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR

Commits

%{all_commits}

Edited by Amy Qualls

Merge request reports