This page briefly describes a formatting rules for Confluence pages.
Table of contents
If the page is long or has many sectional division it is recommended to add a table of contents. The preferred way is to have a small box with links in the top-right corner of the page. It can be done by creating a section divided into two columns. The standard template for this is shown below:
{section}
{column}
The text in the left column
{column}
{column:width=30%}
{panel}*On this page:*{toc:style=disc|indent=10px}{panel}
{column}
{section}
Section headers and page name
Do not add a level 1 header. It is already provided by Confluence on the top of the page. Use headers of the level 2 or higher.
Name pages in the correct English. Do not use shortcuts (like "Impl"). Use spaces between words.
Make use of Confluence formatting
Confluence offers a lot of possible formatting options and macros. Make use of them (if they are relevant). For example, if you want to warn a user about some system behaviour you may want to use a {warning} panel:
Warning
Warning!
Check the notation guide for more examples.
Make all images uniform
Images should use similar formatting. Most of pictures used in the documentation are UML diagrams. Take a look at this diagram:
It was created in Visual Paradigm. The background of class elements is a light green gradient. Connectors have rounded edges.