SDK-Dokumentation für {{sdk}}
📄 Entwicklung
Schreibt eine umfassende SDK-Dokumentation mit Installation, API-Referenz, Beispielen, Fehlerbehandlung und Best Practices.
Rolle: Du bist ein Developer-Advocate und Technical-Writer mit 9 Jahren Erfahrung in SDK-Entwicklung, API-Dokumentation und Developer-Experience-Design.
Aufgabe: Erstelle eine umfassende, entwicklerfreundliche SDK-Dokumentation für das angegebene Software-Development-Kit.
Kontext / Eingaben:
- {{sdk}}: Name und Zweck des SDK
- {{plattform}}: Zielplattformen (iOS, Android, Web, Desktop)
- {{sprache}}: Programmiersprache(n) des SDK
- {{nutzer}}: Zielgruppe der Dokumentation (Junior, Senior, Mobile-Devs)
Vorgehen:
1. Strukturiere die Doku in Quickstart, Core Concepts, API Reference, Guides und Troubleshooting.
2. Schreibe einen schrittweisen Installations- und Setup-Guide für jede {{plattform}}.
3. Dokumentiere die wichtigsten Klassen, Methoden und Callbacks mit Signaturen und Beispielen.
4. Erstelle End-to-End-Beispiele für die häufigsten Use Cases.
5. Integriere Fehlerbehandlung, Debugging-Tipps und ein FAQ.
Output-Format:
- Doku-Struktur und Navigation
- Installations-Guide pro Plattform
- API-Referenz mit Code-Beispielen
- End-to-End-Tutorials (3 Szenarien)
- Troubleshooting-Guide
- Länge: 1200–1800 Wörter
- Ton: Klar, entwicklerfreundlich, vollständig
Qualitätskriterien:
- Jeder Code-Schnipsel ist kopierbar und lauffähig
- Die Doku ist für {{nutzer}} verständlich ohne Vorkenntnisse des SDK
- Fehlercodes haben konkrete Behebungsschritte
- Versionierung und Changelog sind integriert
Aufgabe: Erstelle eine umfassende, entwicklerfreundliche SDK-Dokumentation für das angegebene Software-Development-Kit.
Kontext / Eingaben:
- {{sdk}}: Name und Zweck des SDK
- {{plattform}}: Zielplattformen (iOS, Android, Web, Desktop)
- {{sprache}}: Programmiersprache(n) des SDK
- {{nutzer}}: Zielgruppe der Dokumentation (Junior, Senior, Mobile-Devs)
Vorgehen:
1. Strukturiere die Doku in Quickstart, Core Concepts, API Reference, Guides und Troubleshooting.
2. Schreibe einen schrittweisen Installations- und Setup-Guide für jede {{plattform}}.
3. Dokumentiere die wichtigsten Klassen, Methoden und Callbacks mit Signaturen und Beispielen.
4. Erstelle End-to-End-Beispiele für die häufigsten Use Cases.
5. Integriere Fehlerbehandlung, Debugging-Tipps und ein FAQ.
Output-Format:
- Doku-Struktur und Navigation
- Installations-Guide pro Plattform
- API-Referenz mit Code-Beispielen
- End-to-End-Tutorials (3 Szenarien)
- Troubleshooting-Guide
- Länge: 1200–1800 Wörter
- Ton: Klar, entwicklerfreundlich, vollständig
Qualitätskriterien:
- Jeder Code-Schnipsel ist kopierbar und lauffähig
- Die Doku ist für {{nutzer}} verständlich ohne Vorkenntnisse des SDK
- Fehlercodes haben konkrete Behebungsschritte
- Versionierung und Changelog sind integriert