diff --git a/doc/contributing/docs/localization/guide.rst b/doc/contributing/docs/localization/guide.rst index 6afc26092f..753b31cd10 100644 --- a/doc/contributing/docs/localization/guide.rst +++ b/doc/contributing/docs/localization/guide.rst @@ -23,6 +23,7 @@ Modal verbs Think twice when translating modal verbs. Avoid using expressions like «вы должны», because they sound like a demand in Russian, and «вам придётся», because it implies that our readers will face a lot of trouble. +Be careful with «нельзя». Make it easy for the user to read the documentation. Gender neutrality @@ -78,6 +79,27 @@ Be creative Please avoid word-for-word translations. Let the resulting text sound as though it was originally written in Russian. +Less is more +~~~~~~~~~~~~ +Be concise and don't repeat yourself. Fewer words are the best option most of the time. + +.. container:: table + + .. list-table:: + :widths: 50 50 + :header-rows: 1 + + * - Don't + - Do + * - Профиль доступа можно назначить для любой роли пользователя, + созданной администратором. + А к ролям по умолчанию привязать профили доступа не получится, + поскольку такие роли редактировать нельзя. + - Профиль доступа можно назначить для любой роли пользователя, + созданной администратором. + Исключение составляют роли по умолчанию, + поскольку их нельзя редактировать. + Topic and focus ~~~~~~~~~~~~~~~ Avoid English word order. @@ -112,6 +134,19 @@ and don’t use «являться» and «осуществляться» unless To learn how to clear your Russian texts of bureaucratese, check `Timur Anikin's training The Writing Dead `_. +.. container:: table + + .. list-table:: + :widths: 50 50 + :header-rows: 1 + + * - Don't + - Do + * - Сообщение исчезнет, как только вы покинете данную страницу. + - Сообщение исчезнет, как только вы покинете страницу. + * - Проверка истечения срока действия паролей производится раз в 30 минут. + - Система раз в 30 минут проверяет, не истек ли срок действия паролей. + Consistency ~~~~~~~~~~~ Use one term for one concept throughout the article.