Many experts, through much research, have compiled golden rules of
documentation writing. These rules apply regardless of medium:
• Use short, simple, familiar words
• Avoid jargon.
• Use culture-and-gender-neutral language.
• Use correct grammar, punctuation, and spelling.
• Use simple sentences, active voice, and present tense.
• Begin instructions in the imperative mode by starting sentences with
an action verb.
• Use simple graphic elements such as bulleted lists and numbered
steps to make information visually accessible.
No comments:
Post a Comment