---
title: Mit KI schreiben
description: Praktische Strategien für Jamdesk-Dokumentation mit KI-Tools – effektive Prompts, Prüflisten und häufige Fehler.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

Diese Strategien funktionieren unabhängig davon, welches KI-Tool Sie verwenden: Claude Code, Cursor, Codex, Copilot oder ein anderes. Eine toolspezifische Einrichtung finden Sie unter [Claude Code](/de/ai/claude-code), [Cursor](/de/ai/cursor) oder [Codex](/de/ai/codex).

## Warum MDX gut mit KI funktioniert

MDX ist eines der einfachsten Formate für die Arbeit mit KI-Tools:

- Vertraute Syntax: KI-Modelle wurden mit Millionen von Markdown-Dateien trainiert und erzeugen daher mit minimalen Prompts gültiges MDX.
- Strukturierte Komponenten: `<Card>`, `<Steps>` und `<Tabs>` folgen vorhersehbaren Mustern, die Modelle schnell erlernen.
- Klartext: MDX enthält keine Binärformate, proprietären Schemas oder Build-Artefakte, die ein KI-Tool interpretieren muss.

## Bessere Prompts schreiben

Der Unterschied zwischen mittelmäßiger und guter KI-Dokumentation liegt meist im Prompt. Formulieren Sie genau, was Sie benötigen.

<Tabs>
  <Tab title="Schwache Prompts">
    ```text
    Write docs for the webhook feature.
    ```

    ```text
    Document authentication.
    ```

    ```text
    Create a getting started guide.
    ```

    Diese Prompts erzeugen generische, aufgeblähte Ausgaben, weil die KI keine Einschränkungen erhält.
  </Tab>
  <Tab title="Starke Prompts">
    ```text
    Write a page documenting our webhook feature. The reader is a developer
    integrating webhooks for the first time. Start with a 3-step quickstart,
    then cover payload format and retry behavior. Reference /src/webhooks
    for the implementation.
    ```

    ```text
    Add a troubleshooting section to the authentication page. Cover these
    three errors: expired tokens, missing scopes, and rate limits. Use
    Accordions for each error. Keep each answer under 4 lines.
    ```

    ```text
    Create a getting started guide that gets the reader from zero to a
    working hello-world in under 2 minutes. Skip the theory and background,
    and jump straight into the install command.
    ```

    Einschränkungen sorgen für fokussierte Ausgaben. Teilen Sie der KI mit, wer die Lesenden sind, welche Struktur verwendet werden soll und was ausgelassen werden kann.
  </Tab>
</Tabs>

### Funktionierende Prompt-Muster

| Muster | Beispiel |
|---------|---------|
| **Lesende angeben** | "The reader is a backend developer who has never used our API" |
| **Struktur benennen** | "Use Steps for the setup flow, then Tabs for language variants" |
| **Längenbegrenzungen festlegen** | "Keep the intro under 2 sentences" oder "Each accordion answer should be 3-4 lines" |
| **Auf Quellcode verweisen** | "Reference the implementation in /src/auth for accuracy" |
| **Auszulassendes nennen** | "Don't explain what REST is. Skip the theory." |
| **Beispielseite angeben** | "Match the tone and structure of /quickstart" |

## KI-Ausgaben prüfen

KI-Tools erzeugen meistens strukturell korrektes MDX. Die subtileren Probleme betreffen Ton, Genauigkeit und überflüssige Inhalte. Arbeiten Sie diese Checkliste vor dem Commit durch.

### Sprachstil prüfen

Lesen Sie die Ausgabe laut vor. Wenn sie wie die Antwort eines Chatbots klingt, schreiben Sie sie um. Achten Sie auf:

- Füllphrasen: "It's important to note that", "This allows you to", "In order to"
- Absicherungen: "You might want to consider", "It's generally recommended"
- Leere Übergänge: "Now that we've covered X, let's move on to Y"
- Schlagwörter: "seamlessly", "robust", "leverage", "streamline"

Streichen Sie diese Formulierungen. Die Seite wird dadurch kürzer und besser.

### Genauigkeit prüfen

KI-Tools erzeugen selbstbewusst falsche Informationen. Überprüfen Sie:

- Funktionieren die Codebeispiele tatsächlich? Kopieren Sie sie, und führen Sie sie aus.
- Sind die Konfigurationsoptionen real? Prüfen Sie sie anhand des Quellcodes.
- Sind die Komponentennamen korrekt? Verwenden Sie nur [vorhandene Komponenten](/de/components/overview).
- Beschreibt die Seite das aktuelle Verhalten und keine geplanten Funktionen?

### Struktur prüfen

- [ ] Das Frontmatter enthält sowohl `title` als auch `description`
- [ ] Ein einleitender Absatz ist vorhanden, ohne vorherige Überschrift
- [ ] Die Seite endet mit Karten unter „Was kommt als Nächstes?“ in einem `<Columns>`-Wrapper
- [ ] Neue Seiten wurden der Navigation in `docs.json` hinzugefügt
- [ ] Keine erfundenen Komponenten; nur Komponenten aus der [Komponentenreferenz](/de/components/overview)

## Häufige Fehler von KI

Diese Fehler treten häufig genug auf, dass Sie darauf achten sollten:

<AccordionGroup>
  <Accordion title="Nicht vorhandene Komponenten erfinden">
    KI-Tools erzeugen `<CodeBlock>`, `<Alert>`, `<Section>`, `<Callout>` und andere Komponenten, die in Jamdesk nicht existieren. Verwenden Sie ausschließlich die in der [Übersicht](/de/components/overview) aufgeführten Komponenten.
  </Accordion>
  <Accordion title="Navigation in docs.json vergessen">
    Eine Seite zu erstellen, ohne sie zu `docs.json` hinzuzufügen, ist der häufigste Fehler. Die Seite existiert zwar, erscheint aber nicht in der Seitenleiste. Aktualisieren Sie beim Erstellen von Seiten immer die Navigation.
  </Accordion>
  <Accordion title="Callouts übermäßig verwenden">
    KI-Tools verpacken gerne jeden zweiten Absatz in eine `<Note>` oder `<Warning>`. Ein oder zwei Callouts pro Seite sind ausreichend. Wenn alles wichtig ist, ist nichts wichtig.
  </Accordion>
  <Accordion title="Zu viel schreiben">
    Eine 200 Zeilen lange KI-generierte Seite enthält meist nur 100 Zeilen tatsächlichen Inhalts. Suchen Sie nach wiederholten Erklärungen, unnötigem Hintergrund und Absätzen, die dasselbe mit anderen Worten sagen. Kürzen Sie konsequent.
  </Accordion>
  <Accordion title="Generische Beschreibungen">
    "This powerful feature allows you to..." sagt den Lesenden nichts. Ersetzen Sie die Formulierung durch eine konkrete Beschreibung: "Send HTTP POST requests to your endpoint when events fire."
  </Accordion>
</AccordionGroup>

## Dokumentation synchron halten

Dokumentation zu schreiben ist der einfache Teil. Sie aktuell zu halten, wenn sich der Code ändert, ist schwieriger.

<Tabs>
  <Tab title="Manuelles Prompting">
    Fordern Sie Ihr KI-Tool nach der Veröffentlichung einer Funktion auf:

    ```text
    I just added [feature]. Update the docs to reflect this change.
    Reference the implementation in /src/[file] for accuracy.
    ```
  </Tab>
  <Tab title="Automatisiert mit /update-jamdesk">
    Das Skill `/update-jamdesk` für Claude Code analysiert Ihre Codeänderungen und erstellt passende Aktualisierungen der Dokumentation. Führen Sie es nach der Implementierung benutzerseitiger Funktionen aus:

    ```text
    /update-jamdesk
    ```

    Die vollständige Einrichtung finden Sie unter [Automatisierte Aktualisierungen](/de/ai/automated-updates).
  </Tab>
</Tabs>

## Seitengerüst

Verwenden Sie dies als Ausgangspunkt für einen Prompt, wenn Sie die KI zum Erstellen einer neuen Seite auffordern:

<Prompt title="Eine Jamdesk-Dokumentationsseite erstellen" actions={["cursor", "claude", "chatgpt"]}>
Erstellen Sie anhand dieser Struktur eine Jamdesk-Dokumentationsseite. Ersetzen Sie jeden Platzhalter durch spezifische, korrekte Inhalte für die von mir beschriebene Funktion.

```mdx
---
title: Feature Name
description: One sentence summarizing what this page covers.
---

Opening paragraph: what problem this solves and who should read this.

## Quick Start

<Steps>
  <Step title="First step">What to do.</Step>
  <Step title="Second step">What to do next.</Step>
</Steps>

## How It Works

Explain the mechanics. Use code examples.

## What's Next?

<Columns cols={2}>
  <Card title="Related Page" icon="arrow-right" href="/path">
    Why the reader would go here next
  </Card>
</Columns>
```
</Prompt>

Die obige Live-Karte enthält die vollständigen Anweisungen und das Seitengerüst. Ihr Quellcode verwendet dieselbe Komponentensyntax, die Sie zu Ihren eigenen Seiten hinzufügen können:

````mdx
<Prompt title="Create a Jamdesk documentation page" actions={["cursor", "claude", "chatgpt"]}>
Create a Jamdesk documentation page using this structure. Replace each
placeholder with specific, accurate content for the feature I describe.

```mdx
---
title: Feature Name
description: One sentence summarizing what this page covers.
---

Opening paragraph: what problem this solves and who should read this.

## Quick Start

<Steps>
  <Step title="First step">What to do.</Step>
  <Step title="Second step">What to do next.</Step>
</Steps>

## How It Works

Explain the mechanics. Use code examples.

## What's Next?

<Columns cols={2}>
  <Card title="Related Page" icon="arrow-right" href="/path">
    Why the reader would go here next
  </Card>
</Columns>
```
</Prompt>
````

## Was kommt als Nächstes?

<Columns cols={2}>
  <Card title="Automatisierte Aktualisierungen" icon="rotate" href="/de/ai/automated-updates">
    Führen Sie `/update-jamdesk` aus, um aus Codeänderungen Dokumentation zu erstellen
  </Card>
  <Card title="MDX-Komponenten" icon="puzzle-piece" href="/de/components/overview">
    Vollständige Referenz der verfügbaren Komponenten
  </Card>
</Columns>