mohitagw15856/pm-claude-skills / i18n/hi/skills/runbook-writer
runbook-writer
Verifiedकिसी सेवा, घटना प्रकार या तैनाती प्रक्रिया के लिए ऑपरेशनल runbook लिखें। जब कोई runbook लिखने, ऑप्स गाइड बनाने, ऑपरेशनल प्रक्रिया दस्तावेज़ित करने या इंसिडेंट रिस्पॉन्स प्लेबुक तैयार करने को कहे, तब इसका उपयोग करें। अवलोकन, पूर्वापेक्षाओं, चरण-दर-चरण प्रक्रियाओं, रोलबैक चरणों, समस्या निवारण तालिका और एस्केलेशन पथों के साथ runbook तैयार करता है।
रनबुक राइटर स्किल
सेवाओं, घटना प्रकारों और तैनाती प्रक्रियाओं के लिए ऑपरेशनल runbook तैयार करता है — ऐसे संरचित कि जिस ऑन-कॉल इंजीनियर ने सिस्टम कभी नहीं छुआ, वह भी दबाव में उनका पालन कर सके।
आवश्यक इनपुट
न दिए गए हों तो ये माँगें:
- runbook किसके लिए है (जैसे पेमेंट सेवा तैनात करना, डेटाबेस फ़ेलओवर पर प्रतिक्रिया, API कुंजियाँ बदलना)
- runbook प्रकार (तैनाती / इंसिडेंट रिस्पॉन्स / रखरखाव / डिज़ास्टर रिकवरी)
- सिस्टम/सेवा का नाम और यह क्या करती है (संक्षिप्त विवरण)
- श्रोता (नए ऑन-कॉल इंजीनियर / अनुभवी SRE / DevOps टीम)
- टेक स्टैक (जहाँ प्रासंगिक — जैसे Kubernetes, AWS RDS, Node.js)
- मॉनिटरिंग टूल (जैसे Grafana, Datadog, CloudWatch, Splunk — चरणों में विशिष्ट डैशबोर्ड और अलर्ट लिंक नामित करने के लिए)
- मुख्य एनवायरनमेंट विवरण (जैसे Kubernetes क्लस्टर नाम, AWS खाता/क्षेत्र, प्रासंगिक namespace या संसाधन नाम — सटीक कमांड के लिए जो प्रासंगिक हो पेस्ट करें)
आउटपुट फ़ॉर्मैट
Runbook: [runbook शीर्षक] सेवा: [सेवा का नाम] प्रकार: [तैनाती / इंसिडेंट रिस्पॉन्स / रखरखाव / DR] अंतिम अपडेट: [आज की तारीख़ YYYY-MM-DD प्रारूप में] स्वामी: [टीम या व्यक्ति] गंभीरता: [P1 / P2 / P3 — घटना-प्रकार हो तो]
अवलोकन
यह runbook क्या कवर करता है: [1–2 वाक्य उस परिदृश्य पर जिसे यह runbook सँभालता है]
इस runbook का उपयोग कब करें:
- [विशिष्ट ट्रिगर स्थिति 1 — जैसे PagerDuty अलर्ट:
high-error-rate-payment-service] - [विशिष्ट ट्रिगर स्थिति 2 — जैसे
mainमें PR मर्ज होने के बाद डिप्लॉय ज़रूरी]
पूरा करने का अनुमानित समय: [X मिनट / नतीजे के अनुसार X–Y मिनट]
सही ढंग से पूरा न होने पर प्रभाव: [जैसे पेमेंट प्रोसेसिंग बाधित / डेटा हानि जोखिम / उपयोगकर्ता लॉक आउट]
पूर्वापेक्षाएँ
आवश्यक पहुँच:
- [सिस्टम/टूल पहुँच — जैसे AWS कंसोल:
production-account] - [क्रेडेंशियल — जैसे
vault read secret/payment-service] - [ज़रूरत हो तो VPN / bastion पहुँच]
आवश्यक टूल:
- [टूल का नाम और संस्करण — जैसे
kubectlv1.28+] - [CLI या डैशबोर्ड का नाम]
शुरू करने से पहले:
- [पूर्वापेक्षा जाँच — जैसे Grafana में सत्यापित करें कि वर्तमान तैनाती स्वस्थ है]
- [पूर्वापेक्षा कार्रवाई — जैसे
#ops-liveमें घोषणा करें कि आप शुरू कर रहे हैं]
प्रक्रिया
हर चरण को क्रमांकित करें। सटीक कमांड उपयोग करें। टूल के नाम या फ़्लैग को परिभाषित न करें।
चरण 1: [क्रिया का नाम] [आप क्या कर रहे हैं और क्यों — एक वाक्य]
# Exact command
[command here]
अपेक्षित आउटपुट: [यह काम किया तो क्या दिखना चाहिए]
यह विफल हो तो: [देखने योग्य सटीक एरर संदेश] → [क्या करें, या समस्या निवारण देखें]
चरण 2: [क्रिया का नाम] [चरण 1 जैसी संरचना]
चरण 3: सत्यापित करें मुख्य प्रक्रिया के बाद हमेशा सत्यापन चरण शामिल करें:
[verification command]
अपेक्षित स्थिति: [यह runbook पूरा होने के बाद स्वस्थ सिस्टम कैसा दिखता है]
रोलबैक
कुछ ग़लत हो जाए तो इस प्रक्रिया को कैसे पूर्ववत करें:
चरण R1: [रोलबैक क्रिया]
[rollback command]
रोलबैक सत्यापित करें: [रोलबैक सफल होने की पुष्टि का कमांड]
समस्या निवारण
| लक्षण | संभावित कारण | समाधान |
|---|---|---|
| [एरर संदेश या अवलोकन योग्य लक्षण] | [यह क्यों होता है] | [सटीक फ़िक्स या अगला कदम] |
| [एक और लक्षण] | [कारण] | [समाधान] |
एस्केलेशन
अगर यह runbook समस्या हल न करे:
| स्थिति | किससे संपर्क करें | कैसे |
|---|---|---|
| [जैसे 10 मिनट बाद DB अनुपलब्ध] | [DBA ऑन-कॉल] | [PagerDuty नीति: db-oncall] |
| [जैसे पेमेंट प्रदाता अनुत्तरदायी] | [वेंडर संपर्क] | [1Password में संपर्क: vendor-escalation] |
एस्केलेट करने से पहले हमेशा [टूल] में घटना की समयरेखा अपडेट करें।
प्रक्रिया-पश्चात चेकलिस्ट
runbook पूरा करने के बाद:
-
#ops-liveमें नतीजे के साथ पूर्णता की घोषणा करें - घटना टिकट / डिप्लॉय लॉग अपडेट करें
- मॉनिटरिंग डैशबोर्ड में सत्यापित करें कि अलर्ट हल हो गए
- अगर इसने इस runbook की कोई कमी उजागर की — अभी अपडेट करें (संपादन प्रक्रिया का लिंक)
गहरी सामग्री
यह स्किल सहायक फ़ाइलों के साथ आती है — उपलब्ध हों तो उनका उपयोग करें:
references/3am-usability.md— रात 3 बजे की परीक्षा: थके हुए इंसानों के लिए runbook। आउटपुट बनाते समय इसे लागू करें; इसमें वह कैलिब्रेशन और निर्णय-विवेक है जिसे ऊपर का संक्षिप्त तरीका संकुचित कर देता है।templates/runbook.md— डिलिवरेबल का भरने योग्य संस्करण, गुणवत्ता-जाँच इनलाइन सहित। जब उपयोगकर्ता दस्तावेज़ खुद बनाना चाहे, उसे जनरेट करवाने के बजाय, तब यह पेश करें।
स्कोरिंग रूब्रिक (0–40)
इस स्किल का कोई भी आउटपुट सौंपने से पहले स्कोर करें; 32+ शिप-गुणवत्ता है।
| आयाम | 0 | 5 | 10 |
|---|---|---|---|
| कमांड की सटीकता | चरण बिना कमांड की धुँधली क्रियाएँ हैं ("डिप्लॉय स्क्रिप्ट चलाएँ") | ज़्यादातर चरणों में कमांड हैं, पर कुछ टूल नाम परिभाषित करते हैं या फ़्लैग छोड़ते हैं | हर चरण में सही फ़्लैग और स्पष्ट चिह्नित प्लेसहोल्डर के साथ सटीक, कॉपी-पेस्ट योग्य कमांड है |
| सफलता और विफलता का संकेत | कोई अपेक्षित आउटपुट नहीं; पाठक नहीं बता सकता चरण काम किया या नहीं | सिर्फ़ सुखद पथ पर अपेक्षित आउटपुट; विफलता पथ "जाँच करें" कहते हैं | हर चरण अपेक्षित आउटपुट और नामित विफलता पथ या समस्या निवारण लिंक बताता है |
| रोलबैक की पूर्णता | रोलबैक गायब या प्लेसहोल्डर के रूप में छोड़ा | रोलबैक कमांड हैं पर आंशिक और बिना सत्यापन | रोलबैक पूरा, स्वतंत्र रूप से परखने योग्य, और हर रोलबैक चरण का अपना सत्यापन कमांड है |
| नए पाठक के लिए उपयोगिता | सिस्टम ज्ञान मानता है; अस्पष्ट जार्गन; "[टीम का नाम]" जैसी एस्केलेशन सेल | टीम का सदस्य पालन कर सकता है, पर आंतरिक ज्ञान की कमियाँ बाहरी को रोक देंगी | जिस इंजीनियर ने सिस्टम कभी नहीं छुआ वह दबाव में इसे निष्पादित कर सके; हर एस्केलेशन पंक्ति में वास्तविक संपर्क या स्पष्ट [FILL IN] चिह्न है |
गुणवत्ता जाँच
- हर चरण में सटीक कमांड है (कोई "डिप्लॉय स्क्रिप्ट चलाएँ" नहीं)
- हर चरण के लिए अपेक्षित आउटपुट बताया गया है ताकि इंजीनियर जाने यह काम किया या नहीं
- हर चरण के लिए विफलता पथ स्पष्ट है ("विफल हो तो जाँच करें" नहीं)
- रोलबैक प्रक्रिया पूरी और स्वतंत्र रूप से परखने योग्य है
- एस्केलेशन तालिका में सिर्फ़ "[टीम का नाम]" वाली कोई सेल नहीं — हर पंक्ति में या तो वास्तविक संपर्क हो या स्पष्ट रूप से [FILL IN: ऑन-कॉल रोटेशन लिंक] चिह्नित हो
- रोलबैक खंड में कम से कम एक ठोस कमांड है ("[rollback command]" प्लेसहोल्डर नहीं छोड़ा)
- runbook का पालन वह व्यक्ति कर सकता है जिसने यह सिस्टम कभी नहीं छुआ
उपयोग के उदाहरण
- "[सेवा] तैनाती के लिए runbook लिखो"
- "[अलर्ट प्रकार] के लिए इंसिडेंट रिस्पॉन्स runbook बनाओ"
- "मुझे [प्रक्रिया] के लिए runbook चाहिए"
- "[X] की ऑपरेशनल प्रक्रिया दस्तावेज़ित करो"
- "[परिदृश्य] के लिए ऑप्स प्लेबुक लिखो"
एंटी-पैटर्न
- चरणों को "डिप्लॉय स्क्रिप्ट चलाएँ" जैसी धुँधली क्रियाओं के रूप में न लिखें — हर चरण में सटीक कमांड शामिल होना चाहिए
- रोलबैक खंड को प्लेसहोल्डर न छोड़ें — बिना परीक्षित रोलबैक प्रक्रिया का runbook अधूरा और ख़तरनाक है
- हर चरण का अपेक्षित आउटपुट न छोड़ें — इसके बिना ऑन-कॉल इंजीनियर नहीं बता सकता चरण सफल हुआ या नहीं
- एस्केलेशन संपर्क "[टीम का नाम]" न लिखें — हर एस्केलेशन पंक्ति में वास्तविक संपर्क या भरने का स्पष्ट चिह्न होना चाहिए
- यह न मानें कि पाठक सिस्टम जानता है — उस व्यक्ति के लिए लिखें जिसने इसे पहले कभी नहीं छुआ
उदाहरण ट्रिगर वाक्य
- "एक runbook लिखो।"
- "एक ऑप्स गाइड बनाओ।"
- "एक ऑपरेशनल प्रक्रिया दस्तावेज़ित करो।"
- "एक इंसिडेंट रिस्पॉन्स प्लेबुक तैयार करो।"
इस स्किल को अपने ब्राउज़र में चलाएँ: https://mohitagw15856.github.io/pm-claude-skills/skill/runbook-writer.html
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |