Editing Wiki editing guidelines (section)

== Writing Style ==

Writing style is very important. When people come to use your wiki page they are trying to quickly find information. Try not to over elaborate. Use short sentences and short paragraphs. 

Most readers will be programmers who, as a rule, don't much care if the grammar isn't perfect (though that helps). If you have something useful to add we would rather you wrote something with inaccurate grammar than nothing at all.

If you use code snippets from your repository you may have to modify it slightly so that general readers can understand. You don't want to go into a lengthy explanation of your repository set up just so that you can quote code from it.

If you find your page is getting very long you may find you should be making it into 2 pages. If you can logically split the information into two pages please do. It makes your document less daunting.