C✳CODEZ.WIN
🌐 हिन्दी

स्थानीयकृत पठन मार्गदर्शिका

documentationउद्देश्य, उपयोग और स्रोत

तकनीकी दस्तावेज़ लिखें और उनका रखरखाव करें। "इसके लिए दस्तावेज़ लिखें", "इसका दस्तावेज़ीकरण करें", "रीडमी बनाएं", "रनबुक लिखें", "ऑनबोर्डिंग गाइड" जैसे निर्देशों का उपयोग करके या जब उपयोगकर्ता को किसी भी प्रकार के तकनीकी लेखन - एपीआई दस्तावेज़, आर्किटेक्चर दस्तावेज़ या ऑपरेशनल रनबुक - में सहायता की आवश्यकता हो, तब इसका उपयोग करें।

स्रोत प्राप्त किया गया:

स्रोत रिपॉज़िटरी
anthropics/knowledge-work-plugins
SKILL.md
engineering/skills/documentation/SKILL.md
रिपॉज़िटरी Star
34,049
रिपॉज़िटरी का अंतिम अपडेट
2026-10-30
क्षमता वर्गीकरण
दस्तावेज़
अंतिम संग्रह समय

लाइसेंस: Apache-2.0

वर्कफ़्लो के अंश केवल पढ़ने में सहायता के लिए हैं, कोडेज़ से निष्पादन योग्य निर्देश नहीं हैं। इस पृष्ठ को बनाने के लिए किसी तृतीय-पक्ष स्किल का उपयोग नहीं किया गया है।

नीचे दिए गए उद्देश्य और कार्यप्रणाली संबंधी अंश प्रारंभिक सामग्री हैं, जिन्हें पढ़ने के लिए व्यवस्थित और अनुवादित किया गया है। ये अलग से लेबल किए गए कोडेज़ संपादकीय विश्लेषण से भिन्न हैं।

यह कौशल क्या करता है

तकनीकी दस्तावेज़ लिखें और उनका रखरखाव करें। "इसके लिए दस्तावेज़ लिखें", "इसका दस्तावेज़ीकरण करें", "रीडमी बनाएं", "रनबुक लिखें", "ऑनबोर्डिंग गाइड" जैसे निर्देशों का उपयोग करके या जब उपयोगकर्ता को किसी भी प्रकार के तकनीकी लेखन - एपीआई दस्तावेज़, आर्किटेक्चर दस्तावेज़ या ऑपरेशनल रनबुक - में सहायता की आवश्यकता हो, तब इसका उपयोग करें।

अपस्ट्रीम वर्कफ़्लो कैसे काम करता है

तकनीकी दस्तावेज़ीकरण

विभिन्न लक्षित दर्शकों और उद्देश्यों के लिए स्पष्ट और सुगम तकनीकी दस्तावेज लिखें।

ऊपर की ओर मार्ग · L6 ↗

रीडमी

यह क्या है और यह क्यों मौजूद है? त्वरित शुरुआत (<5(पहली सफलता तक पहुंचने में लगने वाले मिनट)

ऊपर की ओर मार्ग · L12 ↗

एपीआई दस्तावेज़ीकरण

एंडपॉइंट संदर्भ के साथrequest/responseउदाहरण: प्रमाणीकरण और त्रुटि कोड

ऊपर की ओर मार्ग · L18 ↗

आवश्यकताएँ और सेटअप

इस फ़ाइल से कोई संक्षिप्त आवश्यकताएँ नहीं चुनी गईं। इसका मतलब यह नहीं है कि स्किल की कोई निर्भरता नहीं है। रिपॉजिटरी सेटअप निर्देशों और संदर्भित फ़ाइलों की जाँच करें।

सीमाएं और गुणवत्ता जांच

इस फ़ाइल से कोई अलग सीमा अंश नहीं चुना गया है। इसका मतलब यह नहीं है कि यह स्किल हर इनपुट या वातावरण के लिए सुरक्षित है। संपूर्ण स्रोत की समीक्षा करें और अपने परिणाम की पुष्टि करें।

सुरक्षित परीक्षण से शुरुआत करें

  1. समर्थित होस्ट और रिपॉजिटरी इंस्टॉलेशन निर्देशों की जाँच करें। स्किल डायरेक्टरी और उससे संबंधित स्क्रिप्ट, एसेट्स और डॉक्यूमेंटेशन को एक साथ रखें;SKILL.mdअकेले होने पर निर्भरताओं को छोड़ा जा सकता है।
  2. एजेंट को अपना वास्तविक इनपुट, अपेक्षित आउटपुट और स्वीकृति मानदंड प्रदान करें। इनवोकेशन सिंटैक्स और उपलब्ध उपकरण होस्ट पर निर्भर करते हैं; यह साइट किसी सार्वभौमिक इंस्टॉलेशन कमांड को नहीं मानती है।
  3. डिस्पोजेबल प्रोजेक्ट या उसकी कॉपी पर मूल वर्कफ़्लो को आज़माएँ। फ़ाइलों, रिमोट सेवाओं या बिल योग्य संसाधनों में परिवर्तन करने वाले कार्यों की अनुमति देने से पहले उनकी समीक्षा करें।
  4. स्रोत गुणवत्ता जांच और अपनी आवश्यकताओं के आधार पर आउटपुट को सत्यापित करें। सफल ट्रिगर या उच्च रिपॉजिटरी स्टार संख्या सही परिणाम की गारंटी नहीं देते।

कौशल प्रारूप और निर्देशिका विनिर्देश ↗

मूल लेख में आगे पढ़ें

अनुवाद और दायरा

यह पठन मार्गदर्शिका ऊपर पिन किए गए अंशों में से चयनित अंशों को प्रस्तुत करती है।SKILL.mdयह अनुवाद सहायता से किया गया है। यह कोई संपूर्ण नियमावली या परीक्षित संगतता का दावा नहीं है। उपयोग करने से पहले मूल दस्तावेज़ और उससे संबंधित फ़ाइलों को पढ़ें।

यह परिचय नीचे पिन किए गए संस्करण को संदर्भित करता है; वर्तमान रिपॉजिटरी गतिविधि और संग्रह समय अलग से दिखाए गए हैं।

पिन किया गया स्रोत
मूल लेख पढ़ें ↗
स्रोत प्राप्त किया गया
स्रोत कमिट
2574e29377c7173d0cecffef29a6ecbd7f8ccb5d
स्रोत SHA-256
1d469418f786a05be83d2a05f04d68788aeed584d13863a650f5ad73c6c4cf50
संपूर्ण कौशल सूची पर वापस जाएँ