Help:Contributing/styleGuide

language style

1. Get straight to the point. No word padding. Good writers express their best ideas in the least amount of words;
2. Long sentences with complex structures are hard to read. Prefer a few shorter sentences than one long one with multiple sub-clauses;
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?