Skip to content

Commit d5d30ea

Browse files
authored
Update the translation style guide (#2283)
* Add another guideline * Add examples * Add headers to tables * Fix typos * Fix another typo
1 parent b306c31 commit d5d30ea

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

doc/contributing/docs/localization/guide.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Modal verbs
2323
Think twice when translating modal verbs.
2424
Avoid using expressions like «вы должны», because they sound like a demand in Russian,
2525
and «вам придётся», because it implies that our readers will face a lot of trouble.
26+
Be careful with «нельзя».
2627
Make it easy for the user to read the documentation.
2728

2829
Gender neutrality
@@ -78,6 +79,27 @@ Be creative
7879
Please avoid word-for-word translations.
7980
Let the resulting text sound as though it was originally written in Russian.
8081

82+
Less is more
83+
~~~~~~~~~~~~
84+
Be concise and don't repeat yourself. Fewer words are the best option most of the time.
85+
86+
.. container:: table
87+
88+
.. list-table::
89+
:widths: 50 50
90+
:header-rows: 1
91+
92+
* - Don't
93+
- Do
94+
* - Профиль доступа можно назначить для любой роли пользователя,
95+
созданной администратором.
96+
А к ролям по умолчанию привязать профили доступа не получится,
97+
поскольку такие роли редактировать нельзя.
98+
- Профиль доступа можно назначить для любой роли пользователя,
99+
созданной администратором.
100+
Исключение составляют роли по умолчанию,
101+
поскольку их нельзя редактировать.
102+
81103
Topic and focus
82104
~~~~~~~~~~~~~~~
83105
Avoid English word order.
@@ -112,6 +134,19 @@ and don’t use «являться» and «осуществляться» unless
112134
To learn how to clear your Russian texts of bureaucratese,
113135
check `Timur Anikin's training The Writing Dead <https://www.timuroki.ink/thewritingdead>`_.
114136

137+
.. container:: table
138+
139+
.. list-table::
140+
:widths: 50 50
141+
:header-rows: 1
142+
143+
* - Don't
144+
- Do
145+
* - Сообщение исчезнет, как только вы покинете данную страницу.
146+
- Сообщение исчезнет, как только вы покинете страницу.
147+
* - Проверка истечения срока действия паролей производится раз в 30 минут.
148+
- Система раз в 30 минут проверяет, не истек ли срок действия паролей.
149+
115150
Consistency
116151
~~~~~~~~~~~
117152
Use one term for one concept throughout the article.

0 commit comments

Comments
 (0)