ChatGPT – Erstelle eine technische API-Dokumentation zu einer Funktion
Nutze diesen Prompt für die Erstellung einer strukturierten, klar verständlichen und professionell aufgebauten API-Dokumentation auf Basis einer Funktionsbeschreibung. Der Prompt versetzt ChatGPT in die Rolle eines technischen Redakteurs mit Erfahrung in der API-Dokumentation und kombiniert Best Practices aus bekannten Prompt-Cheat-Sheets. Durch Platzhalter kannst du den Prompt flexibel für beliebige Funktionen nutzen.
Hinweis: Die Inhalte dieses Prompts dienen nur zu Informations- und Simulationszwecken und stellen keine professionelle Beratung dar. Wenn du ein konkretes Anliegen hast, wende dich bitte an eine entsprechend qualifizierte Fachperson.
ChatGPT-Prompt für eine strukturierte API-Dokumentation
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.
RolleAgiere 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.
ZielgruppeSoftwareentwickler, 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.
AufgabeErstelle 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.
Visualisierung bzw. AusgabeformatMarkdown-ä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".
Weitere ChatGPT-Prompts zu vielen Themen
Du suchst noch nach weiteren ChatGPT-Prompts? Hier findest du Links zu weiteren Prompts für verschiedene Themen.