aboutsummaryrefslogtreecommitdiffstats
path: root/doc/style-guide-for-documentation
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-07-22 17:33:24 +0200
committerMattias Andrée <maandree@operamail.com>2015-07-22 17:33:24 +0200
commit270764c9a03f5656369ee8eb4d483642812e25c2 (patch)
treeb6309617528f11fb8f0d9cd9474005f183c9c3bf /doc/style-guide-for-documentation
parentstyle guide examples (diff)
downloadmds-270764c9a03f5656369ee8eb4d483642812e25c2.tar.gz
mds-270764c9a03f5656369ee8eb4d483642812e25c2.tar.bz2
mds-270764c9a03f5656369ee8eb4d483642812e25c2.tar.xz
m style guide
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/style-guide-for-documentation')
-rw-r--r--doc/style-guide-for-documentation29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/style-guide-for-documentation b/doc/style-guide-for-documentation
index ff65d2e..88217e7 100644
--- a/doc/style-guide-for-documentation
+++ b/doc/style-guide-for-documentation
@@ -91,6 +91,35 @@ Some examples:
Incorrect: A solar-day on Mars
‘Solar’ is an adjective. Adjectives and nouns are never joined.
+ Incorrect: A speech-to-text technology
+ More incorrect: A speech to text-technology
+ Most incorrect: A speech to text technology
+ Most incorrect: A speechtotexttechnology
+ Correct: A speech-to-text-technology
+ Incorrect: A speech-to-texttechnology
+ ‘speech-to-text’ is a noun, hence one word. ‘technology’ is also
+ a noun. The two nouns must be joined because they form a single
+ noun. However, because ‘speech-to-text’ is a phrase where the words
+ are joined by hyphens (they most be joined by hyphens because it is
+ a phrase,) ‘speech-to-text’ and ‘technology’ most be joined with a
+ hyphen, however, using a space in a case like this is tolerable.
+
+
+
+
+
+Full form versus contracted form
+--------------------------------
+
+Contractions are not acceptable, except, for ‘-n't’, for example
+‘don't’ and ‘won't’. Additionally, ‘o'clock’ is allowed because
+it is considered mandatory in contemporary use, consequentially
+‘of the clock’ must not be written.
+Contractions are especially intolerable when it is ambiguous by
+itself even if the full sentence makes it unambiguous. Therefore
+‘-'s’ and ‘-'d’ most never be used.
+
+