Skip to content

Style guide update, work in progress

Mike Jang requested to merge mjang-pajamas-voice-tone-for-docs into master

What does this MR do?

Goal: start harmonizing the UX Pajamas and Documentation style guides. Initial focus on the TW Language section.

IMO Pajamas does an excellent job w/r/t subdividing style features such as "Voice and Tone", "Terminology", and "Punctuation". I think incorporating those subdivided features would help:

  1. Enhance the styles that we share (in common)
  2. Make it easier for our developer writers to find the styles they need

Related issues

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports