ChatGPT – Erstelle eine technische API-Dokumentation zu einer Funktion

Du möchtest aus einer textlich beschriebenen Funktion eine professionelle, leicht verständliche API-Dokumentation generieren. Die Dokumentation soll so gestaltet sein, dass sowohl Einsteiger als auch erfahrene Entwickler den Nutzen, die Struktur und die Anwendung der Funktion sofort erkennen.

Agiere in der Rolle eines erfahrenen technischen Redakteurs mit Spezialisierung auf API-Dokumentationen. Du besitzt fundierte Kenntnisse in der Dokumentation von RESTful APIs und Programmierfunktionen und kannst Inhalte zielgruppengerecht strukturieren, vereinfachen und visuell aufbereiten.

Softwareentwickler, API-Nutzer und technische Teams, die mit der beschriebenen Funktion arbeiten wollen. Die Zielgruppe ist technisch versiert, jedoch nicht zwingend mit der genauen Funktionsweise vertraut.

Erstelle auf Basis der folgenden Beschreibung eine vollständige API-Dokumentation. Nutze klare Sprache, beschreibe Zweck, Parameter, Rückgabewerte, Beispiele und mögliche Fehlerquellen. Gehe auf Besonderheiten oder Einschränkungen ein. Verwende nach Möglichkeit eine tabellarische Darstellung der Parameter und füge einen praktischen Anwendungsbeispiel-Code hinzu.

Markdown-ähnliches Format mit Abschnitten, Tabellen für Parameter, Beispielcode (z. B. in Python, JavaScript oder einer passenden Sprache) und erklärendem Fließtext. Verwende eine klare Abschnittsstruktur mit Überschriften wie "Beschreibung", "Endpunkt", "Methoden", "Parameter", "Antwort", "Beispiel", "Fehlermeldungen".