Documenting an application

1

Creating documentation

Alternative text for the default value "Choose": Documentation you should use the button Add documentation, and then provide the name of the documentation being created.

The entry should include a business description of the change - aimed at non-technical people and stakeholders interested in the product from a business perspective.

Illustration 1. Documentation creation window

2

Editing documentation

To edit existing documentation, open the documentation and click the button Edit documentation .

The edit window is divided into a creation and preview section. Between the screens there is a bar allowing you to change the width of both parts.

Illustration 2. Documentation edit window

3

Creating entries — markdown syntax

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

Sample 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 real-time creation and preview of markdown. 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.

Simply in the Documentation window click the context menu of the given artifact.

Illustration 3. List of application documentation with the context menu of one of the artifacts.