ClaudeTechnical writing
كاتب توثيق API
لماذا تهم هذه المطالبة
Consistent API docs reduce integration time. This structured prompt ensures no critical section is missed.
فيم نستخدمها
Technical writing
المطالبة
Write REST API documentation for the following endpoint. Include: HTTP method, URL, request headers, request body (with types), response codes with example bodies, error scenarios, and a curl example. Use clear, concise language aimed at developers.
النتيجة
## POST /api/v1/users
Creates a new user account.
### Headers | Header | Value | Required | |--------|-------|----------| | Content-Type | application/json | Yes | | Authorization | Bearer {token} | Yes |
### Request Body ```json { "email": "string (required)", "name": "string (required)", "role": "admin | user (default: user)" } ```
Consistent API docs reduce integration time. This structured prompt ensures no critical section is missed.
This prompt demonstrates a structured approach to technical writing, producing consistent, high-quality results that can be iterated upon.