Formatting Guidelines

Parameters are unfortmatted

Paths to directories or files are preformatted /opt/azeti/SiteController/foobar

{{here is some /path/foobar}}

Right: Headings use Capitalization for Nouns and Important Information and Words 4+ Letters

Wrong: Headings use capitalization for nouns and important Information and words 4+ letters

Writing Instructions

Instructions are numbered lists and links in the software are bold with arrows (dash plus > becomes: → ):

1. Open Components → Edit and set your new component name
2. Choose Lorem Ipsum and do something

XML snippets go into a code bracket with type XML: {code:xml} (this will insert a code macro here) like this:

...

<here is some></here is some>

Screenshots

Screenshots use a Drop Shadow effect  which can be accessed by Edit → Properties

Image Removed

Writing Best Practice

Check this one: http://www.userfocus.co.uk/articles/usermanuals.html

Next Steps