जब मेरा लेखन होता है तो मैं हमेशा दो तीन सेट लिखने में विकसित होता हूं । सिस्टम के आर्किटेक्चर के बारे में एक MUCH LONGER परिशिष्ट के साथ गेट -एर्ग किया चेकलिस्ट, क्यों चीजों को जिस तरह से किया जाता है, ऑनलाइन आते समय संभावित चिपके बिंदु और अमूर्त डिजाइन मान्यताओं के साथ। संभावित समस्याओं और उनके समाधानों की एक सूची के बाद, एक लंबी प्रणाली के साथ एक प्रणाली कैसे काम करती है, यह इस तरह से क्यों करता है, और सही दिशा में लोगों को इंगित करने के लिए उपयोगी अन्य जानकारी के बारे में जानकारी के बाद कुछ अनूठा होना चाहिए।
मेरी पिछली नौकरी में हमें डॉक्टर लिखने की आवश्यकता थी ताकि स्तर -1 हेल्पडेस्क लोग भी चीजों को वापस ला सकें। इसके लिए आवश्यक जाँच सूची थी, जो आम तौर पर लेखन के 3 महीने के भीतर पुरानी हो जाती थी। हमें जब भी संभव हो समस्या निवारण गाइड लिखने का आग्रह किया गया था, लेकिन जब आकस्मिकता पेड़ को इसमें तीन से अधिक शाखाएं मिलती हैं, तो आप बिना सार जाने उस डॉक को नहीं लिख सकते।
जब मैंने अपनी आखिरी नौकरी छोड़ी , तो मैंने जाने से पहले एक 100 पृष्ठ 'अपनी नौकरी कैसे करें' मैनुअल में बदल दी। इसमें सार तत्व था, डिजाइन दर्शन, साथ ही एकीकरण अंक। चूँकि मैं संभवतः एक और sysadmin के लिए लिख रहा था जो मुझे प्रतिस्थापित करने जा रहा था, मैंने इसका उद्देश्य किसी ऐसे व्यक्ति पर किया जो अमूर्त धारणाएँ ले सकता था और उन्हें ठोस कार्यों में बदल सकता था।
पांच साल बीत चुके हैं और मुझे लगता है कि इस पर मेरी राय कुछ हद तक बदल गई है। चेकलिस्ट के रूप में मैनुअल और दस्तावेज़ दोनों दस्तावेज़ के पदानुक्रम में बहुत मूल्यवान स्थान हैं और दोनों का उत्पादन करने की आवश्यकता है। वे बहुत अलग दर्शकों को लक्षित करते हैं, हालांकि।
चेकलिस्ट के रूप में दस्तावेज
इस तरह के प्रलेखन के लिए लक्ष्य बाजार सहकर्मी हैं जो एक चीज कैसे करना चाहते हैं। वे दो प्रकारों में आते हैं:
- सहकर्मी जो सिर्फ एक चीज करना चाहते हैं और पंद्रह पेज मैनुअल के माध्यम से अंगूठे लगाने का समय नहीं चाहते हैं और खुद के लिए कदम उठाते हैं।
- प्रक्रियाएं जो चरणों में काफी जटिल हैं, लेकिन केवल एक बार एक समय में चलने की आवश्यकता है।
अधीरता पहली तरह का ड्राइवर है। हो सकता है कि आपका सहकर्मी वास्तव में यह जानना नहीं चाहता हो कि आउटपुट को 90 कैरेक्टर पर्ल रीजेक्स के माध्यम से क्यों पाइप किया जाना है, बस टिकट को बंद करने के लिए यह होना चाहिए। निश्चित रूप से एक विवरण शामिल करें, जैसे "यह वर्कफ़्लो इस तरह क्यों दिखता है, इसके लिए एक विस्तृत विवरण के लिए, इस लिंक का अनुसरण करें," उन लोगों के लिए चेकलिस्ट में जो जानना चाहते हैं।
दूसरा बिंदु उन प्रक्रियाओं के लिए है जो अक्सर नहीं चलती हैं लेकिन उनमें नुकसान होते हैं। चेकलिस्ट सिर्फ विंगिंग के कुछ डूम से बचने के लिए नक्शे के रूप में कार्य करता है। अगर चेकलिस्ट को एक डॉक्यूमेंटेशन रेपो में रखा जाता है, तो यह उस समय के लिए ईमेल सर्च करने से बचाता है, जब पुराने एडमिन ने HOWTO को भेजा था।
मेरी राय में अच्छे चेकलिस्ट-डॉक्यूमेंटेशन में संभावित विफलता बिंदुओं पर अनुभाग और उन विफलताओं के जवाब भी शामिल हैं। यह दस्तावेज़ को बड़ा बना सकता है और टीएल को ट्रिगर कर सकता है; सहकर्मियों में डीआर प्रतिक्रियाएं, इसलिए मुझे लगता है कि विफलता-मोड और उनकी प्रतिक्रियाओं को चेकलिस्ट से लिंक करने के बजाय पृष्ठ पर ही एक नायाब चेकलिस्ट बनाता है। हाइपरटेक्स्टुलिटी को गले लगाओ।
दस्तावेज़ मैनुअल के रूप में
इस तरह के प्रलेखन के लिए लक्ष्य बाजार वे लोग हैं जो इस बारे में अधिक सीखना चाहते हैं कि सिस्टम कैसे काम करता है। इस दस्तावेज़ से कैसे-कैसे-करें-शैली स्टाइल दस्तावेज़ प्राप्त किया जा सकता है, लेकिन अधिक सामान्यतः मैं इसे वर्कफ़्लो में किए गए निर्णयों का बैक-अप करने के लिए चेकलिस्ट-स्टाइल दस्तावेज़ के पूरक के रूप में देखता हूं।
यह वह दस्तावेज है, जिसमें हम इस तरह के चाव के टुकड़े शामिल करते हैं:
- यह समझाते हुए कि यह इस तरह क्यों कॉन्फ़िगर किया गया है।
- इस खंड में राजनीति जैसे गैर-तकनीकी मुद्दों को शामिल किया जा सकता है कि कैसे पूरी चीज खरीदी और स्थापित की गई।
- सामान्य विफलता मोड और उनकी प्रतिक्रियाएँ समझाते हुए।
- किसी भी सेवा-स्तर-समझौतों की व्याख्या करते हुए, लिखित और वास्तविक दोनों तरह से।
- डी फैक्टो: "अगर यह फाइनल वीक के दौरान विफल हो जाता है तो यह एक ड्रॉप-एवरीथिंग समस्या है। अगर गर्मियों में ब्रेक के दौरान, सो जाओ और सुबह इससे निपटो।"
- उन्नयन और लक्ष्यीकरण को निर्धारित करना।
- राजनीति बाद में अलग हो सकती है, हम शुरुआत में कुछ बुरे विचारों को ठीक क्यों नहीं करते हैं?
जो पूरे सिस्टम की व्यापक समझ प्राप्त करने के लिए बहुत उपयोगी हैं। आपको सरल मानव-स्वचालन कार्यों को चलाने के लिए एक व्यापक समझ की आवश्यकता नहीं है, आपको यह पता लगाने की आवश्यकता है कि कुछ ने ऐसा करने के तरीके को क्यों तोड़ दिया और एक विचार है जहां इसे फिर से नहीं करना है।
आपने डिजास्टर रिकवरी डॉक्यूमेंटेशन का भी उल्लेख किया है जिसे चेकलिस्ट होना है।
मैं समझता हूँ, आप मेरी सहानुभूति हैं।
हां, डीआर प्रलेखन को चेकलिस्ट की तरह होना चाहिए।
हां, डीआर प्रलेखन चेकलिस्टिंग के लिए सबसे प्रतिरोधी है कि कितने तरीके से चीजें टूट सकती हैं।
यदि आपका DR चेकलिस्ट दिखता है:
- डस्टिन या करेन को बुलाओ।
- समस्या के बारे में बताएं।
- पीछे हटो।
आपको कोई समस्या है। यह एक चेकलिस्ट नहीं है, यह एक प्रवेश है कि इस प्रणाली की वसूली इतनी जटिल है कि यह एक वास्तुकार को पता लगाने के लिए लेता है। कभी-कभी यह सब आप कर सकते हैं, लेकिन यदि संभव हो तो इससे बचने की कोशिश करें।
आदर्श रूप से DR प्रलेखन में कुछ अलग चीजों के लिए प्रक्रिया जाँचक शामिल हैं:
- यह पता लगाने के लिए कि क्या गलत हुआ, जो पहचानने में मदद करेगा ...
- कुछ विफलता-मामलों के लिए पुनर्प्राप्ति प्रक्रिया। जिसके द्वारा समर्थित है ...
- वसूली स्क्रिप्ट पहले से ठीक होने के बाद मानव त्रुटि को कम करने में मदद करने के लिए अच्छी तरह से लिखा गया है।
- विफलता के मामलों के बारे में मैनुअल-शैली के दस्तावेज, वे क्यों होते हैं और उनका क्या मतलब है।
ट्राइएज प्रक्रियाएं कभी-कभी सभी डीआर प्रलेखन होती हैं जिन्हें आप कुछ प्रणालियों के लिए बना सकते हैं। लेकिन इसका मतलब है कि 4am कॉल-आउट अधिक समझदार होगा और रिकवरी करने वाले सीनियर इंजीनियर वास्तविक समस्या को तेजी से हल कर पाएंगे।
कुछ विफलता के मामलों में सीधे-आगे वसूली प्रक्रिया होती है। उन्हें दस्तावेज दें। उन्हें प्रलेखित करते समय, आपको ऐसे मामले मिल सकते हैं, जहां आदेशों की सूची एक विशिष्ट क्रम में दर्ज की जा रही है, जो स्क्रिप्टिंग के लिए एक महान उपयोग-मामला है; यह 96 बिंदु पुनर्प्राप्ति प्रक्रिया को 20 बिंदु एक में बदल सकता है। आप कभी भी यह पता नहीं लगा पाएंगे कि क्या आप तब तक कुछ स्क्रिप्ट कर सकते हैं जब तक कि आप पुनर्प्राप्ति प्रक्रिया को कार्रवाई द्वारा मैप नहीं करते हैं।
विफलता के मामलों के लिए मैनुअल-शैली का दस्तावेज़ीकरण अंतिम खाई बैकस्टॉप है जिसका उपयोग तब किया जाता है जब कोई पुनर्प्राप्ति प्रक्रिया नहीं होती है या पुनर्प्राप्ति प्रक्रिया विफल हो जाती है। यह संभवत: किसी और को खोजने के लिए आवश्यक Google-संकेत प्रदान करता है, जिसके पास वह समस्या थी और इसे ठीक करने के लिए उन्होंने क्या किया।