From 893dcb2b8fe026f9cff0b9dc060c7dd23db86a6b Mon Sep 17 00:00:00 2001 From: Damien Picard Date: Mon, 7 Oct 2024 17:25:23 +0200 Subject: [PATCH 1/2] Writing style: mention capitalization of "brand names" This rule was already described in the translation guidelines, it makes sense to add it to the HIG. --- .../human_interface_guidelines/writing_style.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/features/interface/human_interface_guidelines/writing_style.md b/docs/features/interface/human_interface_guidelines/writing_style.md index e1805cf8..ea4357ec 100644 --- a/docs/features/interface/human_interface_guidelines/writing_style.md +++ b/docs/features/interface/human_interface_guidelines/writing_style.md @@ -11,6 +11,11 @@ - Not capitalizing entity names is an arguable guideline, but avoids many fuzzy cases. +- Brand / product names such as *Cycles*, *Grease Pencil*, *Line Art*, *Freestyle* + are always capitalized. + +- “Channel” identifiers, like _X_, _Y_, _Z_, _R_, _G_, _B_, etc. are always capitalized. + - Do not use abbreviations like _verts_, _VGroups_, _loc_, or _rot_, _fac_. Instead, use plain words like _vertices_, _vertex groups_, _location_, _rotation_, _factor_. @@ -20,15 +25,13 @@ much longer, and it helps keeping consistent styling over the whole UI. -- “Channel” identifiers, like _X_, _Y_, _Z_, _R_, _G_, _B_, etc. are always capitalized. - - Do not use implementation specific language. !!! Example "Examples" - Instead of _ID_, use _data-block_. - Do not use terms like _flag_, _string_, _RNA_, _DNA_. -- Don't use pronouns, such as _you_. This sounds like an accusation towards the user.
+- Do not use pronouns, such as _you_. This sounds like an accusation towards the user.
!!! Example **Don't**: _Your mesh is very dense_
-- 2.30.2 From 9e18eb101fcc9c6544b1eb2b2f6c3bad270d8b95 Mon Sep 17 00:00:00 2001 From: Damien Picard Date: Tue, 8 Oct 2024 11:28:03 +0200 Subject: [PATCH 2/2] Writing Style: Mention that EEVEE is uppercase --- .../interface/human_interface_guidelines/writing_style.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/interface/human_interface_guidelines/writing_style.md b/docs/features/interface/human_interface_guidelines/writing_style.md index ea4357ec..4cccd4ca 100644 --- a/docs/features/interface/human_interface_guidelines/writing_style.md +++ b/docs/features/interface/human_interface_guidelines/writing_style.md @@ -12,7 +12,7 @@ many fuzzy cases. - Brand / product names such as *Cycles*, *Grease Pencil*, *Line Art*, *Freestyle* - are always capitalized. + are always capitalized. EEVEE is always uppercase. - “Channel” identifiers, like _X_, _Y_, _Z_, _R_, _G_, _B_, etc. are always capitalized. -- 2.30.2