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

Add Orwell's rules

Browse source
This commit is contained in:
benjamin melançon 2020-07-09 09:10:36 -04:00
parent b3778a0227
commit cb4c55b1cb
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
content-style-guide.md
View file

@ -49,6 +49,15 @@ Focus your message, and create a hierarchy of information. Lead with the main po
* 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.
Many of these repeat or reinforce George Orwell's six rules from his essay "Politics and the English Language" (1946), and it is worth keeping all of them in mind, especially the last:
> (i) Never use a metaphor, simile or other figure of speech which you are used to seeing in print.
> (ii) Never use a long word where a short one will do.
> (iii) If it is possible to cut a word out, always cut it out.
> (iv) Never use the passive where you can use the active.
> (v) Never use a foreign phrase, a scientific word or a jargon word if you can think of an everyday English equivalent.
> (vi) Break any of these rules sooner than say anything barbarous.
### Writing for accessibility ### Writing for accessibility