Difference between revisions of "Help:Author Guidelines for Readability"

From Enviro Wiki
Jump to: navigation, search
Line 1: Line 1:
  
 
==Author Guidelines for Readability==
 
==Author Guidelines for Readability==
Contributors to Remediapedia are afforded a degree of latitude to create content according to the expertise without compromising higher level technical concepts.
+
Contributors to Remediapedia are afforded a degree of latitude to create content according to their expertise without compromising higher level technical concepts.
 
Even so, a few ground rules are good to have in mind when writing articles so that the wiki appeals to the widest possible audience with a need to practice environmental remediation.
 
Even so, a few ground rules are good to have in mind when writing articles so that the wiki appeals to the widest possible audience with a need to practice environmental remediation.
  
 
Please consider these guidelines when writing:
 
Please consider these guidelines when writing:
#Minimize jargon (or at least explain it within the text)  
+
#Avoid or minimize jargon (or at least explain it within the text)  
 
#Spell out acronyms the first time used
 
#Spell out acronyms the first time used
 
#Be concise
 
#Be concise
Line 13: Line 13:
 
#Explain obscure terms
 
#Explain obscure terms
 
#Avoid descriptors that don't enhance the meaning (e.g. substantial, significant etc.)
 
#Avoid descriptors that don't enhance the meaning (e.g. substantial, significant etc.)
 +
#Speak to an audience level between High School Senior and undergraduate studies
  
 
==See Also==
 
==See Also==

Revision as of 16:29, 27 October 2015

Author Guidelines for Readability

Contributors to Remediapedia are afforded a degree of latitude to create content according to their expertise without compromising higher level technical concepts. Even so, a few ground rules are good to have in mind when writing articles so that the wiki appeals to the widest possible audience with a need to practice environmental remediation.

Please consider these guidelines when writing:

  1. Avoid or minimize jargon (or at least explain it within the text)
  2. Spell out acronyms the first time used
  3. Be concise
  4. Use active voice
  5. Simplify for accessibility by readers other than your discipline
  6. Explain specialized terms
  7. Explain obscure terms
  8. Avoid descriptors that don't enhance the meaning (e.g. substantial, significant etc.)
  9. Speak to an audience level between High School Senior and undergraduate studies

See Also

Readability Checker