मैंने पाया है कि कोई भी दस्तावेज NO प्रलेखन से बेहतर है। उपयुक्त राशि आमतौर पर उस समय की मात्रा से निर्धारित होती है जो हमें करना है, या हम फोन कॉल और ईमेल से कितनी नफरत करते हैं।
ऐसा प्रतीत होता है कि आपकी वर्तमान टीम के सदस्यों को उनकी यादों की कुछ अवास्तविक उम्मीदें हैं, या वे अपने लेखन कौशल से शर्मिंदा हैं, और अभ्यास करने के लिए तैयार नहीं हैं।
मुझे लगता है कि मैं एक अल्पसंख्यक (अंग्रेजी प्रमुख जो स्नातक विद्यालय में सॉफ्टवेयर इंजीनियरिंग में शामिल हो गया) में हूं, क्योंकि मुझे दस्तावेजीकरण का काम नहीं मिलता है। यह एक मूल्यवान पेशेवर उपकरण है। हो सकता है कि मुझे अपने कुछ सहकर्मियों के रूप में लिखना उतना कठिन न लगे, लेकिन ऐसा इसलिए है क्योंकि मुझे इसका अधिक अभ्यास है। जब तक इसका प्रलेखन नहीं होता, तब तक मैं किसी परियोजना को समाप्त नहीं मानता, और मैं आमतौर पर इसे विशुद्ध रूप से स्वार्थी कारणों से लिखता हूं: इसलिए मैं लोगों को फोन कॉल और ईमेल लेने के बजाय पढ़ने के लिए कुछ दे सकता हूं, या इसलिए मैं याद रख सकता हूं कि हम आखिरी बार क्या बात कर रहे थे महीने, या तो मैं यह उल्लेख कर सकता हूं कि अगर मैंने रात के मध्य में इसका समर्थन करने की आवश्यकता की तो मैंने कुछ कैसे किया।
दस्तावेज़ीकरण का सबसे अच्छा तरीका यह है कि आप इसे AS GO लिखें, बिल्कुल टेस्ट कोड लिखने की तरह। यह आश्चर्यजनक है कि कुछ पूर्व-लिखित टेम्प्लेट (हेडर, कोड के स्टब्स, आदि के साथ) प्रलेखन को आसान और तेज कर सकते हैं। इस तरह से आप परिवर्तन को पकड़ सकते हैं जैसा कि होता है, और समय के साथ कवर करने के लिए आपके पास कम जमीन होती है। आप इस तरह से अधिक कुशल हैं, चूंकि आप दस्तावेज़ को संदर्भित कर सकते हैं जैसा कि आपको इसकी आवश्यकता है, और आप इसे जिस तरह से बदलते हैं। उदाहरण के लिए, विकी में ऐसा करने से अपडेट आसान हो जाता है, और यदि आप नवीनतम और महानतम हमेशा एक ही स्थान पर ऑनलाइन हैं, तो आप दस्तावेज़ संस्करण के मुद्दों से बच सकते हैं, और आप बस उन लोगों को लिंक भेज सकते हैं जिन्हें इसे पढ़ने की आवश्यकता है।
यदि आप दस्तावेज़ीकरण में थोड़ा समय बिताते हैं, तो आप सभी तेजी से काम करेंगे, खासकर जब कोई नया टीम में शामिल होता है, क्योंकि उन्हें उस समय को सब कुछ पता लगाने में खर्च नहीं करना पड़ेगा। सामान का पता लगाना हमारी नौकरियों का एक मज़ेदार हिस्सा है, लेकिन उत्पादन को ठीक करने की जल्दी में ऐसा करना मज़ेदार नहीं है। यदि हम सभी ने कुछ और नोट्स लिखे तो हम बहुत समय बचा लेंगे।
क्या आपकी टीम के पास परीक्षण, या परीक्षण कोड लिखने के समान मुद्दे हैं? यदि नहीं, तो यह एक आसान बिक्री होगी।
आपका प्रलेखन कई मायनों में उपयोगी है:
1) आप, अभी और अपने सहकर्मियों के लिए, जैसा कि आप परियोजना पर काम करते हैं।
2) अपने ग्राहकों के लिए। प्रलेखन (आरेखों सहित) जो आप उपयोगकर्ताओं को दिखा सकते हैं, बैठकों में चर्चा को आसान बनाता है, खासकर यदि आप जटिल प्रणालियों पर चर्चा कर रहे हैं। यहां तक कि अगर दस्तावेज़ अधूरा है, तो यह शुरू करने के लिए एक जगह है।
3) उन लोगों के लिए जो आपके काम को विरासत में देंगे (जो कि आप भी हो सकते हैं, तीन साल में)। मेरे कई छोटे सहकर्मियों को लगता है कि उन्हें सामान हमेशा याद रहेगा। मुझे पता है कि अगर मैं इसे नहीं लिखूंगा तो मुझे इस सप्ताह यह याद नहीं रहेगा। दस्तावेज़ीकरण होने से आपको आधे दिन बिताने से याद रहता है कि आपको याद है कि आपने कुछ कैसे संरचित किया है, और इसे फिर से जानने के लिए।
4) आप और अन्य के लिए, अगर स्थिति राजनीतिक या विवादास्पद हो जाती है। जैसा कि कोई है जो बैठकों में नोट करता है, खुद को जागृत रखने और बोरियत से लड़ने के लिए, मैं अक्सर निर्णय के लिखित संस्करण के साथ एक ही रहा हूं। जिस व्यक्ति ने इसे लिखा वह विवाद जीत गया। यह याद रखें कि अगली बार जब कोई कहता है कि "उस बैठक को याद रखें जब हम सम्मेलन कक्ष 4 में इस पिछली सर्दियों में थे, जब हम खत्म हो रहे थे? फ्रेड वहां था, और लेखांकन से वह लड़का कौन है?"