Difference between revisions of "Instructions to Wiki Editors"

# For consistency sake it is better to use the '''american spelling''' everywhere rather than mix english and american spellings. That means that you should prefer ''color'' and ''finalize'' over ''colour'' and ''finalise''.

# Please '''do not use contractions''' (e.g ''If you've navigated'' for ''If you have navigated''). They are usually used in spoken english but not much in written english, although there are some exceptions (e.g. ''It doesn't work'' is fine for non formal written english, as is the expended form ''It does not work''). If in doubt use the expended form. Also the User Manual is a bit more formal than for example an e-mail; and as such contractions that might be fine in an e-mail are not necessarily fine in the User Manual.

# '''Do not use very complex grammatical structure or abstruse words''' (''abstruse'' meaning ''difficult to comprehend'' and being an example of words to avoid). Keep in mind that many ScummVM users are not native english speaker and many may not speak english as well as you do.

# ScummVM is distributed on many platforms. When giving instructions on encoding audio or similar tasks try to cover at least Linux, Windows and MacOS X. Most of the users will have one of these operating system.