Razi's Documentation Rules

From openSUSE

Rules

• These rules are currently a work in progress

• The documentation must be written in the imperative tense
  • The first word in the first sentance of a HOWTO page should begin with a verb
  • The first word in the last sentance of a HOWTO page should begin with the past tense of the verb

• [] defines mouse context/window context
• [Some item in the menu] - means click the menu item
• [{some verb} input field] - means perform the action to the item (but the action is not click, eg. [Type Administrator Password]
• [{Input} input field] - means perform the action to the item (but the action is not click, eg. [Type Administrator Password]
• [{Text Input} input field] - means perform the action to the item (but the action is not click, eg. [Type Administrator Password]
• [{Input Field}]
• [{Form Input}]
• [{Radio Button}]
• [{Check Box}]
• [{File Select}]
• [{Menu}]
• see http://www.w3.org/TR/html4/interact/forms.html