Documentation Writer Guide

Jajuk Manual

The following describe the rules to use to write/maintain the Jajuk wiki English Manual.

General Rules

• Do not try to create a translated manual, only work on the English manual. We don't have to workforce to handle translated manuals.
• The title of the page should be self explicit
• The title of the page should be at least two words
• The title of the page should not contain accents (regex: [aA-zZ]). It is strongly encouraged to use only lowercase (regex: [a-z]) to make sure that internal links will be in lowercase only
• Each page of the manual should be tag at the bottom of the page using [[Category:English Manual]]
• Prefer to use icons alone to document an action than more global screenshots to make the documentation task simpler and more resilient to the application changes
• Use bold ''' to highlight most important key word related to this page
• Use italics '' to highlight important key word and key word related to other pages
• In English, you don't have space before a column (:), it is word, column, space, word. (E.g.: word1: word2)
• Use English words before American words (E.g.: use favourite (Commonwealth English) and not favourite (US))
• Refrain from using acronyms and abbreviation
• Don't start word with a capital if they are not the first word of a sentence. Refrain from using caps for keyword
• Use character , and not / do explain different events. E.g: go in menu, view, etc... and not go in menu/view/etc...
• Refrain from using ", prefer the use of '' and '''

See also

• Jajuk Members Guide