Dokumentowanie aplikacji

1

Utworzenie dokumentacji

W zakładce Dokumentacja należy użyć przycisku Dodaj dokumentację, a następnie podać nazwę tworzonej dokumentacji.

Wpis powinien zawierać biznesowy opis zmiany - skierowany do osób nietechnicznych oraz osób zainteresowanych produktem od strony biznesowej.

Ilustracja 1. Okno tworzenia dokumentacji

2

Edycja dokumentacji

Aby edytować istniejącą dokumentację, należy wejść w dokumentację i kliknąć przycisk Edytuj dokumentację .

Okno edycji jest podzielone na część tworzenia i podglądu. Pomiędzy ekranami znajduje się pasek umożliwiający zmianę szerokości obu części.

Ilustracja 2. Okno edycji dokumentacji

3

Tworzenie wpisów — składnia markdown

Wpisy tworzymy używając znaczników markdown. Okno dokumentacji zawiera edytor markdown z podglądem.

Przykładowa dokumentacja z użyciem markdown (przykładowy materiał pokazujący różne elementy składni):

# 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

Edytor obsługuje tworzenie i podgląd markdown w czasie rzeczywistym. Między edytorem a podglądem możesz regulować szerokość za pomocą paska.

4

Zarządzanie artefaktami dokumentacji

Dla artefaktu dokumentacji można:

• podejrzeć historię wersji,

• utworzyć kopię artefaktu,

• pobrać go na dysk.

Wystarczy w oknie Dokumentacji kliknąć menu kontekstowe danego artefaktu.

Ilustracja 3. Lista dokumentacji aplikacji z menu kontekstowym jednego z artefaktów.