Creating and Publishing Knowledge Articles

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

• Link to related articles (see Xero help for examples http://help.xero.com/au/Report_PostJournal) 

See Also

• My Blog Post on tools to write help documents - eg Screen Steps can help you build your knowledge content http://thedetaildept.com.au/2013/08/18/tools-to-help-write-help-documents/
• My Blog Post on documentation http://thedetaildept.com.au/2013/08/18/we-need-to-talk-about-documentation/