Help:Contributing/styleGuide

language style

1. Get straight to the point. No word padding.
2. Use short sentences whenever possible. Long sentences with complex structures are hard to read.
3. Use proper vocabulary. Do not use complex words to show off, but also do not oversimplify risking ambiguity

presentation

1. Show, don't tell. Rather than writing at length about what a config does, show in a sandbox example the results.
2. Use tables for comparison
3. Keep your reader in mind: What is their expected level of expertise? What's their goal? What content would engage them?