चेकआउट सेवा की कैनरी रिलीज़

1) मुझे लेनदेन प्रलेखन की आवश्यकता क्यों है?

• मौखिक ज्ञान को दोहराने योग्य प्रक्रियाओं में बदल दे
• जिम्मेदारी सीमाओं और वृद्धि बिंदुओं को परिभाषित कर
• अनुपालन और सुरक्षा के लिए साक्ष्य के स्रोत के रूप में कार्य करता है;
• ऑनबोर्डिंग को तेज करता है और "संकीर्ण गर्दन" के जोखिम को कम करता है।

2) दस्तावेज़ वर्गीकरण (क्या है)

नीति: इरादे और ढांचा ("क्या और क्यों")। उदाहरण: हादसा प्रबंधन नीति।

मानक: अनिवार्य न्यूनतम आवश्यकताएं ("कितना")। उदाहरण: टीएलएस प्रमाणपत्र नवीकरण तिथि।

SOP/प्रक्रिया: अनुक्रमिक चरण ("के रूप में")। उदाहरण: कैनरी रोल के साथ रिलीज़।

रनबुक: विशिष्ट घटनाओं (अलर्ट/संचालन) के लिए चरण-दर-चरण निर्देश। उदाहरण: "एपीआई 5xx बड़ा हो गया है - क्रियाओं का एल्गोरिथ्म।"

प्लेबुक: विकल्पों और कांटे के साथ परिदृश्य समाधानों का एक सेट। उदाहरण: "भुगतान प्रदाता के साथ समस्याएं।"

केबी (ज्ञान आधार): उत्तर, एफएक्यू, उपकरण सहायता।

चेकलिस्ट - क्रिया से पहले आवश्यक वस्तुओं की एक छोटी सूची।

अभिलेख/साक्ष्य: पूर्ण चरण, स्क्रीनशॉट/लॉग/हस्ताक्षर के लॉग।

3) अच्छे प्रलेखन के सिद्धांत

सत्य का एकल स्रोत (SSOT)। दस्तावेजों की नकल नहीं की जाती है; स्प्रे करने के लिए अप्रचलित हो जाना है।

डॉक्स-ए-कोड। हम गिट में स्टोर करते हैं, पास कोड-रिव्यू, संस्करण और डिफ्यूज़दिखाई देते हैं।

अभियान योग्य-पहला। शुरुआत में - एक छोटा कार्ड: कब शुरू करना है, कौन मालिक है, क्या करना है, पूरा करना मानदंड।

परमाणु और पते की क्षमता। एक दस्तावेज़ - एक कार्य/प्रक्रिया

अपडेटेबिलिटी। स्वामी और एसएलए अपडेट साफ करें (जैसे। त्रैमासिक)।

अवलोकन। डैशबोर्ड/अलर्ट/मैट्रिक्स के लिंक एम्बेडेड हैं।

सुरक्षा-दर-डिजाइन। संवेदनशीलता वर्गीकरण, गुप्त मास्किंग, अभिगम नियंत्रण।

4) दस्तावेज़ जीवन चक्र (शासन)

1. दीक्षा: आवेदन/टिकट → दस्तावेज़ प्रकार → स्वामी।

2. ड्राफ्ट: टेम्पलेट, न्यूनतम उदाहरण, मानकों और एसएलओ के संदर्भ।

3. समीक्षा: तकनीकी (एसआरई/मंच/सुरक्षा), प्रक्रियात्मक (प्रक्रिया प्रबंधक)।

4. प्रकाशन: प्रधान शाखा में, संस्करण/तिथि को चिह्नित करते हुए, स्थिति (सक्रिय/प्रयोगात्मक/पदावनत) प्रदान करता है।

5. प्रशिक्षण/संचार: परिवर्तनों की घोषणा, लघु प्रशिक्षण/डे

6. पूर्वव्यापी: घटनाओं/अभ्यासों के परिणामों के आधार पर, परिवर्तन करना।

7. ऑडिट और संग्रह: अपरिवर्तनीय ट्रेस (जो/जब बदला जाता है), संग्रह में पुराने संस्करण।

5) एसओपी/रनबुक संरचना (न्यूनतम)

1. कार्ड: नाम, आईडी, संस्करण/तिथि, मालिक, जिम्मेदार भूमिकाएं, संबंधित नीतियां/मानक।

2. कब लागू करें: स्थिति प्रारंभ करें (चेतावनी/घटना/कार्य विंडो)।

3. तैयारी: अधिकार/उपकरण/डेटा, जोखिम मूल्यांकन, संचार।

4. चरण: क्रमांकित, कमांड/स्क्रीनशॉट/अपेक्षित परिणाम के साथ।

5. सफलता/रोलबैक मानदंड: स्पष्ट SLI/SLO थ्रेसहोल्ड।

6. वृद्धि: कौन, कब और कैसे (चैनल, फोन, प्रदाता)।

7. सुरक्षा/अनुपालन: संवेदनशील डेटा, निषेध, कार्रवाई का रिकॉर्ड।

8. पोस्ट-एक्शन: टिकट बंद करना, स्थिति को अद्यतन करना, सबूत एकत्र

9. परिवर्तन का इतिहास (changelog)।

6) शैली और डिजाइन नियम

स्पष्ट और छोटा: 1 चरण - 1 क्रिया - 1 परिणाम।

अनिवार्य: "निष्पादन...", "चेक...", "रोल बैक"...।

स्क्रीनशॉट/कमांड: चरण के बगल में; कमांड - कॉपी किए गए ब्लॉक; अपेक्षित आउटपुट पर ध्यान दें।

परिवर्तनशीलता: शाखाएं "यदि A → चरण X, यदि B → स्टेप YE"।

Cohort: जहां संबंधित - निर्दिष्ट क्षेत्र/प्रदाता/किरायेदा

स्थानीयकरण: मुख्य दस्तावेज़ - कम से कम 2 भाषाएँ; अनुवाद की स्थिति निर्दिष्ट करें।

टैग और खोज: सेवा, घटक, प्रदाता, घटना प्रकार, एसएलओ, संस्करण।

7) डॉक्स-ए-कोड और उपकरण

भंडारण: Git (मुख्य/करतब/bugfix), PR समीक्षा, आवश्यक जाँच।

प्रारूप: मार्कडाउन/एस्सीडॉक; ChartineUML/मरमेड JSON/YAML योजनाओं में चार्ट।

प्रकाशन: स्थिर साइट (Docusaurus/MkDocs) + खोज।

सत्यापन: सीआई-लिंट, लिंक परीक्षण, वर्तनी, कोड ब्लॉक सत्यापन।

एकीकरण: चेटोप्स '/रनबुक ओपन एक्स 'कमांड करता है, अलर्ट में नवीनतम संस्करण प्रदर्शित करता है।

लिंक: CMDB/सेवा कैटलॉग ↔ प्रलेखन ↔ डैशबोर्ड।

8) पहुंच नियंत्रण और वर्गीकरण

Классы: सार्वजनिक/आंतरिक/गोपनीय/प्रतिबंधित।

पृथक्करण: सार्वजनिक निर्देश (सामान्य स्थिति) बनाम निजी (कुंजी, आदेश, नेटवर्क आरेख)।

रहस्य: पाठ में निषिद्ध; गुप्त भंडारण और प्लेसहोल्डर्स का उपयोग करें।

संवेदनशील एसओपी के लिए ऑडिट - पढ़ें/बदलें लॉग।

9) घटनाओं और रिलीज के साथ संचार

प्रत्येक अलर्ट में - संबंधित रनबुक के लिए एक लिंक।

प्रत्येक घटना में, एसओपी का एक संदर्भ और निशान की जांच की जाती है।

आरसीए के बाद - CAPA कार्रवाई के रूप में दस्तावेजों को अद्यतन करें।

रिलीज से पहले - चेकलिस्ट: रोलबैक तत्परता, गिरावट झंडे, प्रदाता संपर्क।

10) न्यूनतम आवश्यक सेट (एमवीपी डॉक पैक)

हादसा प्रबंधन और वृद्धि नीति (एसईवी/पी स्तर, समय)।

मानक और सतर्क नीति (बर्न दर, कोरम) की निगरानी।

SOP: रिलीज ़/रोलबैक (कैनरी/ब्लू-ग्रीन), डेटाबेस माइग्रेशन (विस्तार/अनुबंध)।

रनबुक: "उच्च त्रुटि-दर", "p99 विकास", "भुगतान सफलता ड्रॉप", "टीएलएस/डीएनएस समस्या"।

बाहरी प्रदाताओं की प्लेबुक (भुगतान/केवाईसी/सीडीएन): संपर्क, सीमा, फोलबैक।

गुप्त और पहुंच प्रबंधन नीति।

आरसीए और पोस्टमार्टम टेम्पलेट।

सेवा स्वामित्व तालिका (RACI) और डैशबोर्ड मानचित्र।

11) प्रलेखन गुणवत्ता मेट्रिक्स (दस्तावेज़एसएलओ)

कवरेज: SOP/Runbook के साथ महत्वपूर्ण पथ का%।

ताजगी: दस्तावेजों का हिस्सा एन दिनों की तुलना में अधिक हाल का है (उदाहरण के लिए, 90)।

उपयोगिता: बिना वृद्धि के रनबुक के अनुसार% घटनाएं बंद हो गईं।

फाइंडबिलिटी: वांछित दस्तावेज़ (चुनाव/लॉग द्वारा) के लिए औसत खोज समय।

दोष दर: प्रति समीक्षा/100 दस्तावेजों की संख्या।

गोद लेना: सही रनबुक संदर्भ के साथ अलर्ट का प्रतिशत।

अनुपालन साक्ष्य दर: % कार्य संलग्न साक्ष्य के साथ।

12) चेकलिस्ट

एसओपी निर्माण जाँच सूची

• मालिक और लक्षित दर्शक परिभाषित।
• शुरुआती स्थितियां हैं और मानदंड रोकते हैं।
• कदम प्रजनन योग्य हैं, दूसरे इंजीनियर द्वारा जांच की जाती है।
• डैशबोर्ड/अलर्ट/टूल के लिए निर्मित लिंक।
• कोई रहस्य नहीं; प्लेसहोल्डर और एक तिजोरी लिंक हैं।
• रोलबैक और वृद्धि का वर्णन करता है।
• "कार्रवाई के बाद" चेकलिस्ट जोड़ा गया।
• संस्करण, तिथि, चेंजलॉग।

जाँच सूची की समीक्षा करें

• दस्तावेज़ वर्गीकरण से मेल खाता है (नीतियों और कदमों का मिश्रण नहीं करता है)।
• भाषा बिना अस्पष्टता के सरल, अनिवार्य है।
• टीमों ने "ड्राई रन "/स्टेज में परीक्षण किया।
• जोखिम और नियंत्रण बिंदुओं का संकेत दिया गया है।
• आंतरिक/प्रतिबंधित सही है।
• CI में लिंटर्स/सत्यापन पारित किया गया।

13) स्थानीयकरण, संस्करण और उपलब्धता

संस्करण: 'मेजर। माइनर। PATCH ', जहां मेजर प्रक्रिया संगतता को तोड़ ता है।

भाषाएँ: मार्क "स्रोत" भाषा और अनुवाद की स्थिति (अप-टू-डेट/समीक्षा की आवश्यकता)।

फॉर्म फैक्टर: ऑन-कॉल के लिए मोबाइल/नाइट डिस्प्ले, मुद्रित आईसी कार्ड।

14) डॉक ऑटोमेशन (अभ्यास से)

CLI टेम्पलेट से SOP फ्रेमवर्क बनाना ('डॉक न्यू सॉप --सर्विस = पेमेंट्स')।

सेवा टैग द्वारा नवीनतम डैशबोर्ड के लिए स्वतः-सम्मिलित लिंक।

ओवरड्यू दस्तावेज़ अनुस्मारक बॉट्स (ताजगी एसएलए)।

लेखा परीक्षा के लिए अवधि के लिए साक्ष्य पैकेज निर्यात करें।

समाधान में उपयोग किए गए दस्तावेजों के संस्करण के साथ सहयोगी घटना टिकट।

15) सुरक्षा और अनुपालन

अनिवार्य खंड "जोखिम" और "नियंत्रण उपाय"।

हस्ताक्षर/हैश के साथ अपरिवर्तनीय संग्रह में सबूतों का भंडारण।

विनियमों के लिए बाइंडिंग (उदा। अधिसूचना/प्रतिधारण अवधि), स्पष्ट अनुपालन मालिक।

16) एंटी-पैटर्न

मालिकों और अद्यतन तिथियों के बिना "विकी भूलभुलैया"।

राजनेताओं को टीमों के साथ मिलाया गया - किसी को भी नहीं मिलेगा कि क्या कर

संदर्भ के बिना दस्तावेज़ (कोई एसएलओ, डैशबोर्ड, वृद्धि)।

सीएलआई विकल्पों के बिना रहस्यों के साथ स्क्रीनशॉट या "यहां क्लिक करें" निर्देश।

"एक गुरु जानता है कि कैसे" - बिना निर्धारण के आदिवासी ज्ञान।

एकमात्र संस्करण के रूप में अभिलेखित PDF संपादित नहीं हैं, खोजा नहीं गया है.

17) टेम्पलेट (टुकड़े)

एसओपी टोपी (उदाहरण)

SOP-ID: OPS-REL-001

18) दैनिक कार्यों में एम्बेडिंग

साप्ताहिक डॉक्टर-सर्कल: 1-2 दस्तावेजों का विश्लेषण, अद्यतन, अनुभव का आदान-प्रदान।
खेल-दिन: SOP/Runbook वास्तविकता सिमुलेशन में जांच।
ऑनबोर्डिंग: अनिवार्य दस्तावेजों + लघु क्विज़के एक सेट के माध्यम से शुरुआती मार्ग।
डॉक ऋण: प्राथमिकता के साथ सुधार का बैकलॉग (प्रभाव × प्रयास)।

19) नीचे की रेखा

लेनदेन प्रलेखन एक संग्रह नहीं है, बल्कि एक कार्यशील उपकरण है। जब इसे कोड के रूप में प्रबंधित किया जाता है, तो इसमें मालिक, ताजगी मैट्रिक्स होते हैं और घटनाओं, रिलीज और प्रशिक्षण में एम्बेडेड होते हैं, संगठन अनुमानित हो जाता है: कम गलतियां, तेज प्रतिक्रियाएं, समझने योग्य जिम और ऑडिट के लिए। संक्षेप में लिखें, नियमित रूप से अपडेट करें, दिनचर्या को स्वचालित करें - और प्रलेखन समय और धन की बचत शुरू कर दे