Creating and Publishing Knowledge Articles

Owned by Jodie Miners
Feb 18, 2015

Wording

Rules

  • Keyboard keys are keys, not buttons
  • You tap on a glass device, not click
  • You click a mouse.
  • If it's a button, it's a button, if it's a link it's a link. You don't click a hyperlink and say click on the hyperlink button. 

Treat your readers with respect, treat them like you know that they know how to use a keyboard, mouse and device. 

  • Don't say "click on the submit button", just "click Submit". 
  • Don't say "press the 'Left Arrow' and 'Right Arrow' buttons on the keyboard"
  • Capitalise field names and button names (to match the way it is displayed in the app).

Linking

 

See Also