agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update content-style-guide.md typo correction

Browse source
This commit is contained in:
FreeScholar 2020-08-13 17:34:38 +00:00
parent 0868429418
commit 4576f15e22
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
content-style-guide.md
View file

@ -44,7 +44,7 @@ Focus your message, and create a hierarchy of information. Lead with the main po
* Use specific examples. * Use specific examples.
* Avoid vague language. * Avoid vague language.
* Be consistent. Adhere to the copy patterns and style points outlined in this guide. * Be consistent. Adhere to the copy patterns and style points outlined in this guide.
* Do NOT use contractions as they cheapen the content and provide difficulty for seakers and readers of other languages. * Do not use contractions as they cheapen the content and provide difficulty for readers of other languages.
* Use the serial comma. Otherwise, use common sense. (Also known as the Oxford comma, it helps clarify when items in a list of three, four, or more things are their own items.) * Use the serial comma. Otherwise, use common sense. (Also known as the Oxford comma, it helps clarify when items in a list of three, four, or more things are their own items.)
* Don’t use underline, and don’t use any combination of italic, bold, caps, and underline. * Don’t use underline, and don’t use any combination of italic, bold, caps, and underline.
* When in doubt, read your writing out loud. * When in doubt, read your writing out loud.
@ -74,7 +74,7 @@ Place similar topics in the same paragraph, and clearly separate different topic
* Use active voice. * Use active voice.
* Avoid double negatives. * Avoid double negatives.
* Do NOT use contractions as they cheapen the content and provide difficulty for seakers of other languages. * Do not use contractions as they cheapen the content and provide difficulty for readers that do not speak English of other languages.
* Avoid using synonyms for the same word in a single piece of writing. * Avoid using synonyms for the same word in a single piece of writing.
* Write briefly, but don’t sacrifice clarity for brevity. You may need to repeat or add words to make the meaning of your sentences clear to a translator. * Write briefly, but don’t sacrifice clarity for brevity. You may need to repeat or add words to make the meaning of your sentences clear to a translator.
* Avoid slang, idioms, and cliches. * Avoid slang, idioms, and cliches.