Introduction
lorem ipsum
On this page:
Formatting Guidelines
Parameters are unfortmatted
Paths to directories or files are preformatted /opt/azeti/SiteController/foobar
Enclose parameters and paths into double brackets
{{here is some /path/foobar}}
when typing and Confluence automatically applies the preformat style.
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: → ):
- Open Components → Edit and set your new component name
- 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
Writing Best Practice
Check this one: http://www.userfocus.co.uk/articles/usermanuals.html