Application documentation

1

Creating documentation

In the Documentation you should use the button Add documentation, and then enter the name of the documentation being created.

The entry should contain a business description of the change - intended for non-technical people and people interested in the product from a business perspective.

Figure 1. Documentation creation window

2

Documentation editing

To edit an existing documentation, you need to open the documentation and click the button Edit documentation .

The editing window is divided into the editing and preview sections. Between the screens there is a bar that allows changing the width of both sections.

Figure 2. Documentation editing window

3

Creating entries — markdown syntax

We create entries using tags markdown. The documentation window contains a markdown editor with preview.

Example documentation using markdown (sample material showing various syntax elements):

# Markdown syntax guide

## Headers
# This is a Heading h1
## This is a Heading h2
###### This is a Heading h6

## Emphasis
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_

## Lists
### Unordered
* Item 1
* Item 2
  * Item 2a
  * Item 2b

### Ordered
1. Item 1
2. Item 2
3. Item 3
   1. Item 3a
   2. Item 3b

## Images
![This is an alt text.](https://avatars.githubusercontent.com/u/10759137 "This is a sample image.")

## Links
You may be using [Markdown Live Preview](https://markdownlivepreview.com/).

## Blockquotes
> Markdown is a lightweight markup language with plain-text-formatting syntax, created in 2004 by John Gruber with Aaron Swartz.
>>
>> Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

## Tables
| Left columns | Right columns |
| ------------- |:-------------:|
| left foo | right foo |
| left bar | right bar |
| left baz | right baz |

## Blocks of code

The editor supports creating and previewing markdown in real time. Between the editor and the preview, you can adjust the width using the bar.

4

Managing documentation artifacts

For a documentation artifact, you can:

• view version history,
• create a copy of the artifact,
• download it to disk.

It is enough in the window Documentation to click the context menu of the given artifact.

Figure 3. List of the application's documentation with the context menu of one of the artifacts.