दस्तावेज़ को हर चीज़ से बाहर निकालें।
प्रलेखन शुरू करने के बारे में हाल ही में Slashdot पर एक धागा था, जिसने मुझे प्रलेखन के बारे में अपने विचारों को लिखने के लिए प्रेरित किया।
मेरे मुख्य बिंदु थे:
सिद्धांत # 1: यह कभी नहीं किया है
दस्तावेज़ीकरण एक चालू प्रयास है जो हमेशा उत्पादन में पीछे रहता है। परिवर्तन को तदर्थ बनाया जाता है, चीजों को इधर-उधर स्थानांतरित या बंद कर दिया जाता है या यादृच्छिक रूप से सेवा में डाल दिया जाता है। डॉक्यूमेंटेशन कभी पकड़ में नहीं आएगा।
आपको चल रहे प्रलेखन को अद्यतित रखने पर समय (और इसलिए, पैसे) के मूल्य पर बिलों का भुगतान करने वाले लोगों को बेचना होगा। अक्सर उन वार्तालापों को इस तरह से जाना जाता है: "याद रखें कि जब मुझे $ TIME खर्च करना पड़ा था, तब पता चला था कि $ THING कैसे टूटी थी? वैसे जब मैं खत्म हो गया था, तो इस तकनीकी नोट का विस्तार $ THING था, ताकि अगला आदमी साथ न आए। यह सब पता लगाना है। "
आपको इसे करना होगा, भले ही आप कभी खत्म नहीं करेंगे।
सिद्धांत # 2: कोई दस्तावेज नहीं है, केवल गलत दस्तावेज है
यह एक सिद्धांत की तुलना में अधिक तुषारवाद है। दस्तावेज़ीकरण आपको झूठे अर्थों में यह बता सकता है कि कुछ ज्ञात स्थिति में है और अगर कुछ गलत हो जाता है तो आप इसे ठीक करने में एक चालू शुरुआत कर सकते हैं।
इस समस्या को स्वीकार करना महत्वपूर्ण है।
सिद्धांत # 3: आप अपने उत्तराधिकारी के लिए दस्तावेज लिख रहे हैं
ऑड्स आपके द्वारा किए गए दस्तावेज़ का 95% हिस्सा हैं, जिन्हें आपको फिर से संदर्भित नहीं करना पड़ेगा। दस्तावेज़ीकरण भविष्य के लिए ज्ञान का एक संग्रह है, न कि आपके लिए। इसलिए आपको यह मानकर चलना होगा कि आपके दर्शक इस बात के बारे में बहुत कम या कुछ नहीं जानते हैं कि चीजें किस तरह से हैं।
और एक उत्तराधिकारी होगा। मैं तुम्हारे बारे में नहीं जानता, लेकिन मैं अपने जीवन के बाकी हिस्सों के लिए इन विशिष्ट वातावरणों में रहने की योजना नहीं बनाता। अवसर आते हैं और चले जाते हैं, और जब वे आते हैं, कभी-कभी आप जाते हैं। लेकिन जीवन आपके पीछे चला जाता है, और आप अपने उत्तराधिकारी के लिए जीवन को बेहतर बना सकते हैं। अन्यथा आपके पास पूर्व ग्राहकों का एक संग्रह हो सकता है जो चुपचाप आपके बारे में बेकार बातें कहते हैं। मुझे यह कहना पसंद है कि यह वही 50 लोग हैं जो ओटावा में आईटी में हर जगह काम करते हैं क्योंकि आप हर जगह उन्हें चलाते रहते हैं। आपके उत्तराधिकारी की मदद करने से भविष्य में आपके लिए दरवाजे खुल सकते हैं।
अब कुछ हद तक मुसीबत आने पर हमेशा "पिछले आदमी को दोष देना" की एक डिग्री होती है। यह व्यवसाय का हिस्सा है। मैंने खुद किया है। लेकिन कई मौकों पर जब मैंने पिछले आदमी को किसी तरह के मोरन के रूप में विस्फोट किया था, तो मैंने सीखा है अन्यथा उसने वास्तव में अपने कार्य को एक साथ किया था और उस समय जो मैंने किया था उसके बारे में अधिक जानता था।
सिद्धांत # 4: "क्यों" अक्सर "कैसे" से अधिक महत्वपूर्ण होता है
जब एक प्रणाली को देखते हुए हम में से अधिकांश सोचने लगते हैं कि आखिर ऐसा क्यों है? किए गए कॉन्फ़िगरेशन विकल्पों के लिए लगभग हमेशा बहुत विशिष्ट कारण हैं। इन परिस्थितियों में, "क्यों" "हाउ" को निर्देशित करता है, और आपको यह सुनिश्चित करना होगा कि आपके समाधान के धुएं के अवशेषों की जांच करते समय पाठक विशिष्ट समस्याओं को समझे।
सिद्धांत # 5: यह आसान होना चाहिए या आप ऐसा नहीं करेंगे
इसका मतलब है कि आपको अपने औजारों के साथ-साथ उन लोगों के बारे में भी जागरूक होना होगा जो आपके साधनों का उपयोग करने जा रहे हैं।
चीजों को अप-टू-डेट रखना आसान है। यदि आपको किसी भी तरह का प्रयास करना है, तो आपको सबसे अच्छा होने पर इसे करने से बचने के लिए बहाने मिलेंगे, जो कि बदलाव के तुरंत बाद होता है।
यदि आपके उपकरण दूसरों के लिए उपयोग करना आसान नहीं हैं, तो वे इसका उपयोग नहीं करेंगे। यह विशेष रूप से एक टीम के माहौल में अपंग हो सकता है, क्योंकि जितनी बड़ी टीम को अधिक संभावना होगी आप एक टीम के सदस्य का सामना करेंगे, जो आपकी पसंद का उपकरण पसंद नहीं करता है।
व्यक्तिगत रूप से, मुझे दस्तावेजों के लिए विकि पसंद है। हालांकि समस्या यह है कि विकी आप पर एक संरचना को लागू नहीं करता है, इसलिए संरचना को बाहर से लगाया जाना चाहिए। यह हमेशा कहीं न कहीं संघर्ष का कारण बनता है क्योंकि किसी और के पास एक बेहतर / अलग विचार है।
कुछ स्थानों पर मैंने Word और Visio दस्तावेज़ों को "प्रकाशित" पीडीएफ में उपयोग किया है, जिनमें "नवीनतम" पीडीएफ को आधिकारिक माना जाता है। यह अच्छा है कि आपके पास तब एक संग्रह है जिसे आप अपने नियोक्ता / उत्तराधिकारी को सौंप सकते हैं। पीडीएफ, यदि ठीक से दिनांकित किया गया है, तो जो हुआ, उसका एक ऐतिहासिक रिकॉर्ड प्रदान कर सकता है, हालांकि जो कि नेविगेट करना आसान नहीं है। यह बुरा है कि मुझे Word या Visio पसंद नहीं है और विचारों को प्रभावी ढंग से संवाद करने के लिए इन उपकरणों की बुनियादी समझ प्राप्त करने के लिए मजबूर किया गया है।
मेरा वर्तमान नियोक्ता एक शेयरपॉइंट पोर्टल में वर्ड दस्तावेजों के विचार के साथ कर रहा है। हमें बस यह देखना होगा कि हम वहां कितने दूर हैं