Prompts voor technologie en ontwikkeling
Genereer API-documentatie van Stripe-niveau - authenticatie, endpoints, fouten en webhooks - zodat ontwikkelaars zich kunnen authenticeren, hun eerste aanroep kunnen doen en een fout binnen 10 minuten kunnen afhandelen.
Deze prompt voor het genereren van AI API-documentatie maakt documentatie die is afgestemd op de OpenAPI-specificatie - overzicht, authenticatiehandleiding, snelstart, endpointreferentie met codevoorbeelden in meerdere talen, foutafhandeling met oplossingen, snelheidsbeperking, webhooks, SDK's, versiebeleid en changelog - in het formaat dat leiders op het gebied van developer experience gebruiken. Plak de prompt in Claude, ChatGPT of een willekeurige AI-chat, voeg je API-specificatie toe en ontvang documentatie die klaar is voor Docusaurus, ReadMe, Mintlify of GitBook.
Authenticatie komt op de eerste plaats - een ontwikkelaar die zich niet kan authenticeren, haakt af. Elke foutrespons wordt gedocumenteerd met statuscode, oorzaak en oplossing (stille fouten zijn niet toegestaan). Elk endpoint bevat complete, realistische request- en responsevoorbeelden in meerdere talen - placeholderwaarden zoals "example_value_1" zijn niet acceptabel. Werkt met Claude, ChatGPT of elk AI-chatmodel.
Wat je krijgt
- Eén production-ready prompt voor het genereren van AI API-documentatie (900+ woorden)
- Volledige documentatiestructuur - overzicht, authenticatie, snelstart, endpointreferentie, fouten, snelheidslimieten, webhooks, SDK's, changelog
- Endpointreferentie met codevoorbeelden in meerdere talen (cURL, Python, JavaScript, Go, Ruby - kies er 3-5)
- Volledige tabel met foutcodes - status, code, oorzaak en oplossing voor elke fout
- Aanpasbaar voor REST-, GraphQL-, webhook-intensieve, enterprise/SOAP-, uitsluitend interne en partnergerichte API's
Ontworpen voor
Backendontwikkelaars
Platformteams
Developer Relations
Technische architecten
DX-engineers