Mit KI schreiben

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, Cursor oder 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.

Write docs for the webhook feature.

Document authentication.

Create a getting started guide.

Funktionierende Prompt-Muster

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

Häufige Fehler von KI

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

Dokumentation synchron halten

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

I just added [feature]. Update the docs to reflect this change.
Reference the implementation in /src/[file] for accuracy.

Seitengerüst

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

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

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:

<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?