Language Guidelines: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Condensed the sections and gave links to the MS guide)
(Replaced content with "Category:Writing Guidelines This page is now integrated as part of the Qt Writing Guidelines.")
Tags: Replaced Visual edit
Line 1: Line 1:
[[Category:Writing Guidelines]]
[[Category:Writing Guidelines]]
This page is part of the [[QtWritingGuidelines | Qt Writing Guidelines]].




We use the [https://learn.microsoft.com/en-us/style-guide/welcome/ Microsoft Writing Style Guide] in the Qt documentation. Essentially, use clear and direct language in '''American English'''. We write to a diverse audience and we need to communicate Qt topics in an approachable and understandable manner.
This page is now integrated as part of the [[QtWritingGuidelines | Qt Writing Guidelines]].
 
 
Here are some clarifications for Qt documentation:
 
# Use '''active voice''', not passive. Passive does not make a sentence formal, but unnecessarily weakens the sentence. See [https://learn.microsoft.com/en-us/style-guide/grammar/verbs Verbs]
# Use the pronoun '''you''' in to address the reader when appropriate. See [https://learn.microsoft.com/en-us/style-guide/grammar/nouns-pronouns Nouns and Pronouns].
# Use '''because''' instead of "since" or "as". See [https://learn.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences Use simple words, concise sentences].
# Use a serial comma, also known as the '''Oxford comma'''. See [https://learn.microsoft.com/en-us/style-guide/punctuation/commas Commas]
# Use US spelling and avoid latin abbreviations. See [https://learn.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words Use US spelling and avoid non-English words]. Here is a summary :
 
{| class="wikitable"
|+
!Use
!Instead of
!
!
|-
|for example
|e.g.
|
|
|-
|that is
|i.e.
|
|
|-
|namely
|viz.
|
|
|-
|therefore
|ergo
|
|}

Revision as of 13:50, 15 December 2024


This page is now integrated as part of the Qt Writing Guidelines.

Retrieved from "https://wiki.qt.io/index.php?title=Language_Guidelines&oldid=43579"