Writing Tips and Tricks - ansible/community GitHub Wiki

This is a section to handle some writing advice that is too detailed to put in our Style Guide but might be of interest to docs contributors.

Writing for Translation

How would you position the word "only" to make it more translation-friendly? (Hint: which option is easier for you to understand?)

Option 1: You can only live migrate instances when the parameter is set to "true". This parameter is only enabled by default when the host is configured for a particular deployment.

Option 2: You can live migrate instances only when the parameter is set to "true". This parameter is enabled by default only when the host is configured for a particular deployment.

Answer: Option 2 is more localization friendly. "only" should be placed just before the words or phases that it emphasizes. It can cause ambiguity when it appears too early in the sentence, as in Option 1.