Skip to content

Commit e3f135e

Browse files
Allow contractions #329
1 parent a082b51 commit e3f135e

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

xml/docu_styleguide.language.xml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,11 @@
224224
<section xml:id="sec-contraction">
225225
<title>Contractions</title>
226226
<para>
227-
Do not use contractions (such as <quote>don't</quote>), unless you are
228-
purposefully writing a casual document.
227+
You may use common contractions (such as <quote>don’t,</quote> <quote>it’s</quote>
228+
or <quote>we’ll</quote>) to make your writing more natural and conversational.
229+
Contractions improve readability and engagement by reflecting how people
230+
speak. Be consistent: do not mix a contraction (for example, <quote>can’t</quote>)
231+
with its fully spelled form (<quote>cannot</quote>) in the same document.
229232
</para>
230233
</section>
231234
<section xml:id="sec-dash">
@@ -517,9 +520,10 @@
517520
<section xml:id="sec-tone">
518521
<title>Tone and voice</title>
519522
<para>
520-
Maintain a professional tone. Do not use contractions, except in casual
521-
documents. Do not use humor. Be honest and avoid absolutes and
522-
exaggerations, but focus on positive aspects.
523+
Maintain a professional tone that is helpful and honest. Do not use
524+
humor, and avoid absolutes or exaggerations; instead,
525+
focus on positive aspects and factual accuracy. Contractions
526+
are permitted to keep the writing engaging and conversational.
523527
</para>
524528
<para>
525529
Use the second person (<quote>you</quote>) to refer to the reader.

0 commit comments

Comments
 (0)