Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions doc/contributing/docs/localization/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,9 @@ Term choice examples
* - state machine
- машина состояний (конечный автомат, state machine)
- машина состояний
* - write-ahead log (WAL)” at first entry, “WAL” later
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

Copy link
Contributor Author

@patiencedaur patiencedaur Aug 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The examples are plain terms without descriptions. The previous version includes descriptions, which might create confusion and is also inconsistent with the example in the first row. Same for the punctuation. We don't want to describe source terms, because the section is about target terms.

* - write-ahead log; WAL
- журнал упреждающей записи (write-ahead log, WAL)
- журнал упреждающей записи; WAL; журнал WAL *(using a descriptor)*
* -
-
-

Best practices
--------------
Expand All @@ -84,10 +81,13 @@ Let the resulting text sound as though it was originally written in Russian.
Topic and focus
~~~~~~~~~~~~~~~
Avoid English word order.
The Russian speech is structured with topic and focus (тема и рема).

The Russian speech is structured with topic and focus
(`тема и рема <https://ru.wikipedia.org/wiki/Актуальное_членение_предложения>`_).
The topic is the given in the sentence, something we already know.
The focus is whatever new/important information is provided in the sentence
about the topic.
In Russian, the focus most often stands at the end of the sentence,
In written Russian, the focus most often stands at the end of the sentence,
while in English, sentences may start with it.

.. container:: table
Expand All @@ -108,6 +108,7 @@ No bureaucratese
Avoid overly formal, bureaucratic language whenever possible.
Prefer verbs over verbal nouns,
and don’t use «являться» and «осуществляться» unless it’s absolutely necessary.

To learn how to clear your Russian texts of bureaucratese,
check `Timur Anikin's training The Writing Dead <https://www.timuroki.ink/thewritingdead>`_.

Expand All @@ -124,7 +125,7 @@ Avoid elliptical sentences
.. container:: table

.. list-table::
:widths: 30 30 40
:widths: 20 30 50
:header-rows: 1

* -
Expand All @@ -141,15 +142,14 @@ Do all the pronouns point to the exact nouns you want them to?
**Example (how not to):**
Прежде чем добавить запись в конфигурацию, укажите к ней путь.

In the example above, it is not quite clear
what «к ней» means -- to the record or to the configuration.
For more on this issue, check out
In the example, it is not quite clear what «к ней» means---to the
record or to the configuration. For more on this issue, check out
`the writers' reference at «Ошибкариум» <https://lapsus.timuroki.ink/pest/wanderer/>`_.

Be critical
~~~~~~~~~~~
Be critical towards your text
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Tidy up your translation until it feels just right.
Don't forget to proofread your translation. Check your text at least twice.

Be nice to your peers
~~~~~~~~~~~~~~~~~~~~~
Expand Down