Skip to content

Update Technical Writing workflows with additional review direction

Craig Norris requested to merge docs-tw-handbook-review into master

Why is this change being made?

The TW reviews section in the Technical Writing handbook would benefit from additional information, directing Technical Writers to create follow-on issues for items identified during documentation-related reviews that would slow or block the release of the documentation-related MR.

(While I was in there, I also fixed some line wrapping for the CODEOWNERS line a bit above the refinement of the TW reviews section. I couldn't help myself. It doesn't represent a content change, so it can just "happen" as part of this MR.)

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to your manager.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files.
Edited by Craig Norris

Merge request reports