Skip to content

Update docs style guide to recommend avoiding Latin phrases

Marcin Sedlak-Jakubowski requested to merge msj-docs-style-latin into master

What does this MR do?

Uses input from discussion in technical-writing#77 (closed).

To set it as a recommendation and not as a hard rule and thus not raise the bar for doc contributions, I settled on saying:

We recommend avoiding Latin abbreviations, such as...

I'm open for better suggestions!

Related issues

Closes technical-writing#77 (closed)

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