Skip to content

mohitagw15856/pm-claude-skills / i18n/hi/skills/api-docs-writer

api-docs-writer

Verified

डेवलपर्स के लिए स्पष्ट API दस्तावेज़ लिखें। जब कोई API एंडपॉइंट दस्तावेज़ित करने, API रेफ़रेंस डॉक्स लिखने, डेवलपर गाइड बनाने या कच्चे स्पेक/Postman कलेक्शन को दस्तावेज़ में बदलने को कहे, तब इसका उपयोग करें। विवरण, पैरामीटर, रिक्वेस्ट/रिस्पॉन्स उदाहरण और एरर कोड के साथ एंडपॉइंट दस्तावेज़ तैयार करता है।

FileKindSize
SKILL.mdskill md16.1 KB
---
# machine-translated to hi from skills/api-docs-writer/SKILL.md — review: pending. Native fixes welcome via PR.
name: api-docs-writer
description: "डेवलपर्स के लिए स्पष्ट API दस्तावेज़ लिखें। जब कोई API एंडपॉइंट दस्तावेज़ित करने, API रेफ़रेंस डॉक्स लिखने, डेवलपर गाइड बनाने या कच्चे स्पेक/Postman कलेक्शन को दस्तावेज़ में बदलने को कहे, तब इसका उपयोग करें। विवरण, पैरामीटर, रिक्वेस्ट/रिस्पॉन्स उदाहरण और एरर कोड के साथ एंडपॉइंट दस्तावेज़ तैयार करता है।"
---

# API डॉक्स राइटर स्किल

यह स्किल कच्चे API स्पेक, एंडपॉइंट विवरण या Postman कलेक्शन को OpenAPI से मिलती-जुलती परंपराओं के अनुसार साफ़, डेवलपर-केंद्रित दस्तावेज़ में बदलती है। आउटपुट डेवलपर पोर्टल, README या Notion/Confluence पेज के लिए तैयार होता है।

## आवश्यक इनपुट

जो दिया गया है उसी से काम करें। इनमें से कुछ न हो तो भी पूरा आउटपुट बनाएँ: हर खाली जगह को *(माना गया, पुष्टि करें)* चिह्नित एक उचित धारणा से भरें और अंत में उन धारणाओं की सूची दें। सवाल पहले सिर्फ़ तब पूछें जब मुख्य विषय ही न हो (लिखने के लिए कुछ हो ही नहीं)।
- **API या एंडपॉइंट का विवरण** (कच्चा स्पेक, Postman एक्सपोर्ट, या मौखिक विवरण)
- **प्रमाणीकरण विधि** (API key / Bearer token / OAuth 2.0 / कोई नहीं)
- **बेस URL**
- **API संस्करण** (जैसे v1, v2.3, या "unversioned" — डेप्रिकेशन नोट और वर्ज़निंग हेडर पर असर डालता है)
- **रेट लिमिट** (प्रति टोकन या IP प्रति सेकंड/मिनट अनुरोध, अगर ज्ञात हो — या "अज्ञात")
- **श्रोता** (आंतरिक डेवलपर / बाहरी पार्टनर / सार्वजनिक)
- **आउटपुट फ़ॉर्मैट** (डेवलपर पोर्टल और README के लिए Markdown / Confluence या Notion के लिए सादा गद्य — ध्यान दें: यह स्किल OpenAPI YAML नहीं बनाती)

## आउटपुट फ़ॉर्मैट

हर एंडपॉइंट के लिए निम्न तैयार करें:

---

## `[METHOD] /path/to/endpoint`

**सारांश:** [एक पंक्ति — यह एंडपॉइंट क्या करता है]

**विवरण:** [2–4 वाक्य। इस एंडपॉइंट का उपयोग कब करें। यह क्या लौटाता है। जानने लायक कोई महत्वपूर्ण व्यवहार (पेजिनेशन, रेट लिमिट, async प्रोसेसिंग आदि)]

**प्रमाणीकरण:** [आवश्यक / वैकल्पिक — विधि]

---

### रिक्वेस्ट

**हेडर:**

| हेडर | आवश्यक | विवरण |
|---|---|---|
| `Authorization` | हाँ | `Bearer <token>` |
| `Content-Type` | हाँ | `application/json` |

**पाथ पैरामीटर:**

| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| `id` | string | हाँ | संसाधन का अद्वितीय पहचानकर्ता |

**क्वेरी पैरामीटर:**

| पैरामीटर | प्रकार | आवश्यक | डिफ़ॉल्ट | विवरण |
|---|---|---|---|---|
| `limit` | integer | नहीं | 20 | प्रति पेज अधिकतम परिणाम (1–100) |
| `cursor` | string | नहीं | — | पिछले रिस्पॉन्स से पेजिनेशन कर्सर |

**रिक्वेस्ट बॉडी:**

```json
{
  "field_name": "value",
  "another_field": 42
}
```

| फ़ील्ड | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| `field_name` | string | हाँ | [सादा विवरण कि यह फ़ील्ड क्या करता है] |
| `another_field` | integer | नहीं | [विवरण। लागू हो तो मान्य सीमा या enum मान शामिल करें] |

---

### रिस्पॉन्स

**सफल रिस्पॉन्स: `200 OK`**

```json
{
  "id": "abc123",
  "status": "active",
  "created_at": "2025-04-01T10:00:00Z"
}
```

| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
| `id` | string | बनाए/प्राप्त किए गए संसाधन का अद्वितीय पहचानकर्ता |
| `status` | string | वर्तमान स्थिति। Enum: `active`, `inactive`, `pending` |
| `created_at` | ISO 8601 string | UTC में निर्माण का टाइमस्टैम्प |

---

### एरर कोड

| स्टेटस कोड | एरर कोड | विवरण | कैसे हल करें |
|---|---|---|---|
| `400` | `INVALID_REQUEST` | रिक्वेस्ट बॉडी विकृत है या आवश्यक फ़ील्ड गायब हैं | ऊपर दिए स्कीमा से रिक्वेस्ट बॉडी जाँचें |
| `401` | `UNAUTHORIZED` | प्रमाणीकरण टोकन गायब या अमान्य | अपनी API key जाँचें या टोकन रिफ़्रेश करें |
| `404` | `NOT_FOUND` | अनुरोधित संसाधन मौजूद नहीं है | पाथ पैरामीटर में ID जाँचें |
| `429` | `RATE_LIMITED` | बहुत अधिक अनुरोध | रुकें और `Retry-After` हेडर के मान के बाद दोबारा कोशिश करें |
| `500` | `INTERNAL_ERROR` | अप्रत्याशित सर्वर त्रुटि | exponential backoff के साथ दोबारा कोशिश करें; बनी रहे तो सपोर्ट से संपर्क करें |

---

### कोड उदाहरण

श्रोताओं के लिए प्रासंगिक कम से कम 2 भाषाओं में उदाहरण दें (डिफ़ॉल्ट: cURL + Python):

**cURL:**
```bash
curl -X POST https://api.example.com/v1/endpoint \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"field_name": "value"}'
```

**Python:**
```python
import requests

response = requests.post(
    "https://api.example.com/v1/endpoint",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    json={"field_name": "value"}
)
data = response.json()
```

---

## गहरी सामग्री

यह स्किल सहायक फ़ाइलों के साथ आती है — उपलब्ध हों तो उनका उपयोग करें:

- **`references/example-first-docs.md`** — उदाहरण-प्रथम API डॉक्स: वे नियम जो दस्तावेज़ को उपयोगी बनाते हैं। आउटपुट बनाते समय इसे लागू करें; इसमें वह कैलिब्रेशन और निर्णय-विवेक है जिसे ऊपर का संक्षिप्त तरीका संकुचित कर देता है।
- **`templates/endpoint-entry.md`** — डिलिवरेबल का भरने योग्य संस्करण, गुणवत्ता-जाँच इनलाइन सहित। जब उपयोगकर्ता दस्तावेज़ खुद बनाना चाहे, उसे जनरेट करवाने के बजाय, तब यह पेश करें।

## स्कोरिंग रूब्रिक (0–40)

इस स्किल का कोई भी आउटपुट सौंपने से पहले स्कोर करें; 32+ शिप-गुणवत्ता है।

| आयाम | 0 | 5 | 10 |
|---|---|---|---|
| **पैरामीटर की पूर्णता** | फ़ील्ड बिना प्रकार या आवश्यक/वैकल्पिक चिह्न के सूचीबद्ध | तालिकाएँ पूरी, पर विवरण बताते हैं कि फ़ील्ड *क्या है*, न कि *क्या करता है*; enum और सीमाएँ गायब | हर फ़ील्ड टाइप्ड और सीमित (enum, सीमाएँ, फ़ॉर्मैट), व्यवहार और परिणाम के आधार पर वर्णित |
| **एरर-पथ कवरेज** | सिर्फ़ सुखद पथ — कोई एरर तालिका नहीं | मानक 400/401/404/429/500 पंक्तियाँ हैं पर समाधान का मार्गदर्शन नहीं | पूरा मानक सेट और एंडपॉइंट-विशिष्ट कोड, हर एक के साथ डेवलपर को *क्या करना* चाहिए, असुरक्षित-रीट्राई के मामले सहित |
| **उदाहरणों की चलने-योग्यता** | छद्म-कोड, अपरिभाषित वेरिएबल, या "YOUR_ENDPOINT" प्लेसहोल्डर | उदाहरण हैं पर कॉपी-पेस्ट करके चलने योग्य नहीं या सिर्फ़ एक भाषा में | ≥2 भाषाएँ, वास्तविक बेस URL, स्पष्ट रूप से नकली प्लेसहोल्डर क्रेडेंशियल, पेस्ट करते ही चलने योग्य |
| **व्यवहार की स्पष्टवादिता** | async व्यवहार, पेजिनेशन, idempotency और पुराने quirks छोड़े गए | quirks गद्य में बताए पर उदाहरणों और एरर पंक्तियों से गायब | हर पेच उन्हीं रिक्वेस्ट/रिस्पॉन्स के साथ दस्तावेज़ित जो वह पैदा करता है, असुविधाजनक पुराने व्यवहार सहित |

## गुणवत्ता जाँच

- [ ] हर पैरामीटर दस्तावेज़ित है (प्रकार, आवश्यक/वैकल्पिक, विवरण)
- [ ] रिस्पॉन्स फ़ील्ड प्रकार सहित पूरी तरह दस्तावेज़ित हैं
- [ ] सभी प्रासंगिक एरर कोड समाधान मार्गदर्शन के साथ सूचीबद्ध हैं
- [ ] एरर कोड कम से कम कवर करते हैं: 400 (bad request), 401/403 (auth), 404 (not found), 429 (rate limited), 500 (server error) — या स्पष्ट रूप से बताया गया है कि इस एंडपॉइंट पर कौन से लागू नहीं होते
- [ ] कोड उदाहरण वास्तविक बेस URL और यथार्थवादी प्लेसहोल्डर टोकन का उपयोग करते हैं — कोई उदाहरण स्निपेट के बाहर अपरिभाषित वेरिएबल या "YOUR_ENDPOINT" का संदर्भ नहीं देता
- [ ] प्रमाणीकरण विधि ऊपर स्पष्ट रूप से बताई गई है
- [ ] जहाँ लागू हो, enum मान सूचीबद्ध हैं
- [ ] अगर एंडपॉइंट सूची लौटाता है, तो पेजिनेशन दस्तावेज़ित है

## एंटी-पैटर्न

- [ ] सिर्फ़ सुखद पथ दस्तावेज़ित न करें — हर एंडपॉइंट में कम से कम 400, 401/403, 404, 429 और 500 के एरर कोड होने चाहिए
- [ ] कोड उदाहरणों में "YOUR_ENDPOINT" या "INSERT_TOKEN" जैसे प्लेसहोल्डर मान न लिखें — वास्तविक बेस URL से जुड़े यथार्थवादी प्लेसहोल्डर उपयोग करें
- [ ] जिन फ़ील्ड के स्वीकार्य मानों का सेट तय है, उनके enum मान न छोड़ें — अदस्तावेज़ित enum इंटीग्रेशन बग पैदा करते हैं
- [ ] सूची एंडपॉइंट पर पेजिनेशन का दस्तावेज़ न छोड़ें — जो डेवलपर इसे चूकेंगे, वे ऐसे इंटीग्रेशन बनाएँगे जो चुपचाप डेटा खो देंगे
- [ ] फ़ील्ड "क्या है" बताकर "क्या करता है" बताना न छोड़ें — "ID" दस्तावेज़ नहीं है; "इस संसाधन को प्राप्त या अपडेट करने में प्रयुक्त अद्वितीय पहचानकर्ता" है

## उपयोग के उदाहरण
- "इस API एंडपॉइंट को दस्तावेज़ित करो: [स्पेक या विवरण पेस्ट करें]"
- "इस Postman कलेक्शन को डेवलपर डॉक्स में बदलो"
- "[एंडपॉइंट] के लिए API रेफ़रेंस डॉक्स लिखो"
- "हमारे [प्रोडक्ट] API के लिए डेवलपर गाइड लिखो"

## उदाहरण ट्रिगर वाक्य

- "एक API एंडपॉइंट दस्तावेज़ित करो।"
- "API रेफ़रेंस डॉक्स लिखो।"
- "एक डेवलपर गाइड बनाओ।"
- "कच्चे स्पेक/Postman कलेक्शन को दस्तावेज़ में बदलो।"

इस स्किल को अपने ब्राउज़र में चलाएँ: https://mohitagw15856.github.io/pm-claude-skills/skill/api-docs-writer.html
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall