Skip to content

Reference brand guidelines on voice

Diana Logan requested to merge dianalogan-master-patch-30872 into master

What does this MR do?

This MR follows Adding voice and translation guidance (!101678 - merged)

We have voice guidance in the Brand Guidelines:

Handbook link: https://about.gitlab.com/handbook/marketing/corporate-marketing/brand-activation/brand-standards/#brand-guidelines

Design guide link: https://design.gitlab.com/brand/overview#tone-of-voice

This MR makes a minor tweak to The GitLab voice section in the Documentation style guide to show that we are not defining a new or different voice to the overall Brand. Instead, we are clarifying how we apply the voice to the docs site content.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Diana Logan

Merge request reports

Loading