E-Mail beantworten & klassifizieren
Automatisierungspotenziale identifizieren

API-Dokumentation schreiben

Aus der API-Spezifikation wird eine Doku für Entwickler

So funktioniert dieser Skill

  1. 1Spezifikation liefernAngaben oben ausfüllen, Endpunkte und Formate im Chat nachreichen
  2. 2Architektur erfassenZweck, Endpunkte und Datenmodell aus der Spezifikation ziehen
  3. 3Quick Start schreibenDer kürzeste Weg zum ersten erfolgreichen Aufruf
  4. 4Authentifizierung erklärenHeader, Herkunft des Schlüssels und was bei 401 zu prüfen ist
  5. 5Endpunkte referenzierenJe Endpunkt Parameter, Pflichtangaben und Response
  6. 6Beispiele schreibenDieselbe Anfrage in Curl, JavaScript und Python
  7. 7Fehler und Limits sammelnStatuscodes mit Bedeutung, Rate Limit und Retry-After
  8. 8GegenprüfenOffene Stellen der Spezifikation benennen statt sie zu raten
  9. 9Fertige API-DokumentationÜbersicht bis Changelog, offene Stellen benannt statt geraten
  10. 10Testen und ausliefernAufrufe gegen die echte API laufen lassen, dann ins Developer-Portal stellen

Prompt zum Kopieren

Trag deine Angaben ein oder klick auf einen Namen im Text. Alles bleibt in deinem Browser — wir sehen und speichern es nicht.

# BESCHREIBUNG
Schreibt entwicklerfreundliche API-Dokumentation. Übersetzt technische API-Spezifikationen in klare, nutzbare Dokumentation mit Beispielen für schnelle Integration.

# EINGABE
- API-Spezifikation: Endpunkte, HTTP-Methoden, Parameter (Pflicht)
- Request/Response-Formate: JSON-Schemas, Datentypen (Pflicht)
- Authentifizierungsmethode: Authentifizierung
- Zielgruppe: Zielgruppe der Doku (optional)
- Bestehende Dokumentation: OpenAPI/Swagger, Postman (optional)
- Beispieldaten: realistische Testdaten (optional)

# AUSGABE
Vollständige API-Dokumentation:
1. Übersicht – Was macht die API? Base URL, Versionierung
2. Erste Schritte – Quick Start Guide
3. Authentifizierung – Anleitung mit Beispielen
4. Endpunkt-Referenz – Pro Endpunkt: URL, Methode, Parameter, Response
5. Request-Beispiele – Curl, JavaScript, Python
6. Response-Beispiele – Erfolg und Fehler
7. Fehler-Referenz – HTTP-Statuscodes und Meldungen
8. Rate Limits – Nutzungsbeschränkungen
9. Changelog – Versionshistorie

# KONTEXT
- Dein Name dokumentiert eine API von Unternehmen; sie läuft auf Tech Stack. Richte Begriffe, Code-Beispiele und Tiefe daran aus.
- Domänenwissen: REST-API-Design, HTTP-Standards, Authentifizierungsprotokolle
- Einschränkung: Keine Implementierung, nur Dokumentation

# ARBEITSANWEISUNG
## Schritt 1: API-Architektur verstehen
Verwendungszweck, Endpunkte und Datenmodell erfassen.

## Schritt 2: Quick Start Guide schreiben
Den schnellsten Weg zum ersten erfolgreichen API-Call dokumentieren.

## Schritt 3: Authentifizierung dokumentieren
Mit konkreten Beispielen und Troubleshooting.

## Schritt 4: Endpunkte dokumentieren
Pro Endpunkt: URL, Methode, Parameter, Response mit Beispielen.

## Schritt 5: Fehler-Referenz und Rate Limits
Alle Fehlercodes dokumentieren und Nutzungslimits beschreiben.

## Schritt 6: Qualitätsprüfung
Alle Beispiele auf Korrektheit und Konsistenz prüfen.

# DEFINITION OF DONE
[ ] Alle Endpunkte sind vollständig dokumentiert
[ ] Quick Start Guide ermöglicht schnellen Einstieg
[ ] Authentifizierung ist klar beschrieben
[ ] Jeder Endpunkt hat funktionierende Beispiele
[ ] Fehler-Responses sind dokumentiert
[ ] Code-Beispiele sind syntaktisch korrekt

# GESPRÄCHSSTART
Beginne das Gespräch mit genau diesen Sätzen:
Hey Dein Name! Ich schreibe die API-Dokumentation für Unternehmen und richte sie an Zielgruppe der Doku aus; authentifiziert wird über Authentifizierung. Schick mir die Spezifikation: Endpunkte mit HTTP-Methoden und Parametern, dazu die Request- und Response-Formate.

Was der Skill genau macht

Eine API wird nicht daran gemessen, was sie kann, sondern daran, wie schnell jemand seinen ersten erfolgreichen Aufruf hinbekommt. Genau dort scheitern die meisten Dokumentationen: Sie exportieren die Spezifikation und überlassen dem Leser die Übersetzung.

Der Skill nimmt deine Endpunkte, die Request- und Response-Formate und das Authentifizierungsverfahren und baut daraus ein durchgehendes Dokument — Quick Start zuerst, dann die Authentifizierung mit Beispielen, eine Referenz je Endpunkt, Aufrufe in Curl, JavaScript und Python, dazu Fehler-Referenz, Rate Limits und Changelog. Wo die Spezifikation etwas offen lässt, sagt er dir, was er angenommen hat, statt es stillschweigend zu setzen.

Geschrieben wird für Entwicklerinnen und Entwickler, die eure API anbinden — es geht um Aufrufe, Parameter und Statuscodes. Wer stattdessen ein Handbuch für Instandhalter, Sachbearbeitung oder Endnutzer ohne IT-Vorwissen braucht, ist beim Agenten „Technische-Dokumentation-Ersteller“ richtig: Der erklärt Installation, Bedienung und Troubleshooting am Produkt.

So arbeitest du damit

  1. Das brauchst du.
  2. Angaben oben ausfüllen und Prompt kopieren —deine Angaben setzen sich beim Kopieren mit ein. Den Prompt selbst kannst du dabei frei ändern — kürzen, ergänzen, umschreiben.
  3. In dein Tool der Wahl einsetzen.
    1. Kopiere den Skill-Text oben über den Kopieren-Button.
    2. Klicke auf dein Profilbild und wähle „Skills“.
    3. Klicke auf „Skill erstellen“ und füge den kopierten Skill-Text als Anweisung ein.
    4. Passe bei Bedarf Eingaben, Ausgaben und das gewünschte Format an.
    5. Speichere den Skill — er ist sofort in allen Chats verfügbar.
    OpenAI Dokumentation: Skills in ChatGPT
  1. Die Beispiele gegen die echte API laufen lassen: Jeder Aufruf in Curl, JavaScript und Python muss eine echte Antwort liefern. Ein Beispiel, das nicht läuft, kostet mehr Vertrauen als ein fehlender Abschnitt.
  2. Die benannten Annahmen mit der Entwicklung klären: Was die Spezifikation offen ließ, steht in der Doku als Annahme. Erfahrungsgemäß sind es Pflichtangaben bei Parametern, Standardwerte und der Statuscode einer Antwort.
  3. Die Doku dorthin stellen, wo integriert wird: Developer-Portal, README im Repo oder als Seite hinter dem Partnerzugang — nicht ins interne Wiki.
  4. Bei jedem Release nachziehen: Neue Endpunkte, geänderte Felder und abgekündigte Parameter gehören in Referenz und Changelog, solange die Änderung frisch ist.
  5. Wenn es hakt: Beispiel antwortet mit 401 (Name des Headers und Format des Schlüssels gegen die Spezifikation prüfen), Response-Feld fehlt in der Referenz (Schema war unvollständig, nachreichen), Doku veraltet nach dem Release (Changelog-Punkt in die Release-Checkliste ziehen).
  6. Ausbauen: OpenAPI-Datei aus der fertigen Referenz erzeugen, Postman-Collection dazulegen, Code-Beispiele in weiteren Sprachen, Sandbox-Schlüssel zum Mitprobieren.

Alle Skills