Language Guidelines: Difference between revisions

Latest revision as of 12:04, 10 October 2024

This page is part of the Qt Writing Guidelines.

We use the 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.

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 Verbs
Use the pronoun you in to address the reader when appropriate. See Nouns and Pronouns.
Use because instead of "since" or "as". See Use simple words, concise sentences.
Use a serial comma, also known as the Oxford comma. See Commas
Use US spelling and avoid latin abbreviations. See Use US spelling and avoid non-English words. Here is a summary :


Use	Instead of
for example	e.g.
that is	i.e.
namely	viz.
therefore	ergo

@@ Line 1: / Line 1: @@
-h1. Language Guidelines
+[[Category:Writing Guidelines]]
+This page is part of the [[QtWritingGuidelines | Qt Writing Guidelines]].
-This page is part of the [[QtWritingGuidelines | Qt Writing Guidelines]].
-== Idioms and usage ==
+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.
-=== Since/as/because and ambiguity ===
-According to MSTP both "since" and "as" need to be avoided because they can lead to ambiguous interpretations (causal meaning or temporal meaning). MSTP recommends using "because".
+Here are some clarifications for Qt documentation:
-The Canadian Writer's Handbook also recommends not using "since" and "as".
+# 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 :
-The Chicago Manual of Style doesn't mention this issue.
+{| class="wikitable"
+|+
-A very good article in this respect is Grammar Girl's discussion of this topic:<br />http://grammar.quickanddirtytips.com/although-versus-while.aspx .
+!Use
+!Instead of
-== Spelling ==
+!
+!
-Qt documentation follows the American spelling.
+|-
+|for example
-=== Latin expressions commonly used in English ===
+|e.g.
+|
-i.e. (that is)<br />e.g. (for example)<br />cf. (compare)<br />etc. (and so forth)<br />vs.(versus)<br />et al. (and others)
+|
+|-
-It is advisable to use the English equivalent for better readibility.
+|that is
+|i.e.
-== Punctuation ==
+|
+|
-=== Oxford comma ===
+|-
+|namely
-In punctuation, a serial comma (also called Oxford comma) needs to be placed immediately before the conjunction (often "and" or "or") in a series of three or more terms.
+|viz.
+|
-Example:
+|
+|-
-I would like crackers, cheese, and garlic.
+|therefore
+|ergo
-=== The comma as a separator between compound sentences. ===
+|
+|}
-Use commas to separate independent clauses when they are joined by any of these seven coordinating conjunctions: and, but, for, or, nor, so, yet.
-However, the comma can be dropped in the following cases:
-* if both independent clauses are quite short, especially if the two clauses are very closely related, and even more so if the subject of both clauses is the same, or
-* if only the first clause is quite short, especially if the two clauses are very closely related, and even more so if the subject of both clauses is the same.
-=== Periods and spaces ===
-The period ending a sentence should be followed by 1 space.
-An exception to this rule is the legal text in the beginning of Qt code, which can have 2 spaces after a period.
-== Grammar issues ==
-=== Genitive ===
-Can we use the possessive 's if the owner is not a person ?
-Example:<br />* the item's width<br />* the width of the item
-Both are correct. There is presently no rule stating that the owner cannot be an inanimate object.
-=== An URL or a URL ? ===
-A URL.
-If the "u" is long, the article is "a". For example, a uniform, a university, a Ugandan man.
-If it is short, the article is "an". For example, an understatement, an undermining comment, an underdog team.
-== Usage and idioms ==
-=== Using the second personal pronoun in manuals ===
-Avoid using "you" in technical documents.
-When correcting this, use the passive voice, an imperative, and/or rephrase the sentence.
-For example:<br />You can override this function for your delegate if you need extra logic to decide which transition to return.<br />==> This function can be overridden for the delegate if extra logic is required to decide which transition to return.
-== Sources ==
-The Chicago Manual of Style, 14th edition. The University of Chicago Press.<br />"English Language &amp; Usage": http://english.stackexchange.com/about.

Language Guidelines: Difference between revisions

Latest revision as of 12:04, 10 October 2024

Navigation menu

Search