# Dokumentationen erstellen

Die Dokumentations-Funktion ermöglicht es Eigentümern von Ressourcen und Lösungs-Administratoren, ausführlichen Kontext über die erstellte Ressource oder Lösung zu geben. Das kann zum Beispiel eine detailliertere Beschreibung eines Datensatzes sein oder Sinn, Zweck und Einordnung einer gesamten Lösung.

### **Wo die Dokumentations-Funktion zu finden ist**

* Auf der Seite `Übersicht` eines **Datensatzes**
* Auf der Seite `Übersicht` eines **Formulars**
* Auf der Seite `Übersicht` einer **Lösung**

Klicken Sie auf die kleine Schaltfläche ✏️ neben dem Abschnitt `Dokumentation`, um den Editor zu öffnen.

### **Verwendung des Editors**

Der Editor unterstützt flexible Inhaltsblöcke. Um einen Block hinzuzufügen, bewegen Sie den Mauszeiger über die Zeile, zu der Sie den Block hinzufügen möchten, klicken Sie auf das Symbol ➕, das auf der linken Seite erscheint, oder drücken Sie `/`, um das Blockmenü zu öffnen. Um einen Block zu verschieben, verwenden Sie die gepunktete Schaltfläche neben der Zeile, die neben dem Symbol ➕ erscheint.

**Verfügbare Blöcke**

| Blocktyp            | Beschreibung                                                         |
| ------------------- | -------------------------------------------------------------------- |
| `Text`              | Beginnen Sie mit der Eingabe von einfachem Text                      |
| `Überschrift 1`     | Große Abschnittsüberschrift                                          |
| `Überschrift 2`     | Mittlere Unterüberschrift                                            |
| `Überschrift 3`     | Kleine Unterüberschrift                                              |
| `Tabelle`           | Erstellen Sie eine einfache 2D-Tabelle                               |
| `Akkordeon`         | Zusammenklappbarer Inhalt für lange Abschnitte                       |
| `Aufzählungsliste`  | Ungeordnete Liste von Elementen                                      |
| `Nummerierte Liste` | Geordnete Liste von Schritten oder Punkten                           |
| `Aufgabenliste`     | Fügen Sie Kontrollkästchen zur Aufgabenverfolgung hinzu              |
| `Hinweis`           | Heben Sie einen Tipp oder eine wichtige Notiz hervor                 |
| `Blockzitat`        | Fügen Sie ein Zitat oder eine Bemerkung mit visueller Betonung hinzu |
| `Code`              | Zeigen Sie Ausschnitte von Code oder Befehlen                        |
| `Teiler`            | Trennen Sie Abschnitte visuell                                       |
| `Einbetten`         | Fügen Sie Medien wie Videos, Karten oder Links ein                   |

## **Tipps**

* Sie können mehrere Blöcke kombinieren, um Ihre Notizen zu strukturieren
* Verwenden Sie Überschriften und Trennlinien, um längere Dokumentationen zu organisieren

{% hint style="warning" %}
Ihre Dokumentation wird **nicht** automatisch gespeichert. Bitte speichern Sie diese immer nach dem Aktualisieren mit dem kleinen Speicher-Symbol neben der Überschrift **Dokumentation**.
{% endhint %}
