# Dokumentowanie aplikacji

{% stepper %}
{% step %}

### 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.

<figure><img src="/files/NWDkZPHquCBWsF9CgRPC" alt=""><figcaption><p><em><strong>Ilustracja 1.</strong> Okno tworzenia dokumentacji</em></p></figcaption></figure>
{% endstep %}

{% step %}

### Edycja dokumentacji

Aby edytować istniejącą dokumentację, należy wejść w dokumentację i kliknąć przycisk **Edytuj dokumentację** ![Ilustracja 2](/files/d3ceadd2360fe4a6ef276b024a85b3aca4fba4fc).

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.

<figure><img src="/files/UEDccsN4S6AKSyEbXZed" alt=""><figcaption><p><em><strong>Ilustracja 2.</strong> Okno edycji dokumentacji</em></p></figcaption></figure>
{% endstep %}

{% step %}

### Tworzenie wpisów — składnia markdown

Wpisy tworzymy używając znaczników [markdown](https://www.markdownguide.org/basic-syntax/). 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):

{% code fullWidth="false" expandable="true" %}

```markdown
# 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
```

{% endcode %}

{% hint style="info" %}
Edytor obsługuje tworzenie i podgląd markdown w czasie rzeczywistym. Między edytorem a podglądem możesz regulować szerokość za pomocą paska.
{% endhint %}
{% endstep %}

{% step %}

### 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.

<figure><img src="/files/YqAA3DoLYRXAyc9dHdrx" alt=""><figcaption><p><em><strong>Ilustracja 3.</strong> Lista dokumentacji aplikacji z menu kontekstowym jednego z artefaktów.</em></p></figcaption></figure>
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.eximee.com/budowanie-aplikacji/aplikacja-biznesowa/dokumentowanie-aplikacji.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.