एक सप्ताह में कोड की 100,000 पंक्तियों को कैसे पढ़ें और ठीक करें

शुरुआत में किसी बड़े और पुराने प्रोजेक्ट को समझना हमेशा मुश्किल होता है। वास्तुकला एक वास्तुकार मूल्यांकन की गतिविधियों में से एक है। आम तौर पर आपको बड़ी, पुरानी परियोजनाओं के साथ काम करना पड़ता है, और परिणाम एक सप्ताह में मिलना चाहिए।

एक सप्ताह में कोड की 100k या अधिक लाइनों की परियोजना का मूल्यांकन कैसे करें, साथ ही ऐसे परिणाम भी प्रदान करें जो ग्राहक के लिए वास्तव में उपयोगी हों।

अधिकांश आर्किटेक्ट और तकनीकी नेतृत्वकर्ताओं को समान परियोजना मूल्यांकन का सामना करना पड़ा है। यह एक अर्ध-औपचारिक प्रक्रिया या एक अलग सेवा की तरह लग सकता है जैसा कि हमारी कंपनी में किया जाता है, आप में से अधिकांश ने किसी न किसी तरह से इससे निपटा है।

आपके गैर-रूसी भाषी मित्रों के लिए अंग्रेजी में मूल यहां है: एक सप्ताह में वास्तु मूल्यांकन.

हमारी कंपनी का दृष्टिकोण

मैं आपको बताऊंगा कि यह हमारी कंपनी में कैसे काम करता है और मैं समान परिस्थितियों में कैसे कार्य करता हूं, लेकिन आप अपने प्रोजेक्ट और कंपनी की जरूरतों के अनुसार इस दृष्टिकोण को आसानी से बदल सकते हैं।

वास्तुकला मूल्यांकन दो प्रकार के होते हैं।

आंतरिक - हम आम तौर पर कंपनी के भीतर परियोजनाओं के लिए ऐसा करते हैं। कोई भी परियोजना कई कारणों से वास्तुकला मूल्यांकन का अनुरोध कर सकती है:

1. टीम को लगता है कि उनका प्रोजेक्ट एकदम सही है और यह संदिग्ध है। हमारे पास ऐसे मामले हैं, और अक्सर ऐसी परियोजनाओं में सब कुछ आदर्श से बहुत दूर होता है।
2. टीम अपने प्रोजेक्ट और उनके समाधानों का परीक्षण करना चाहती है।
3. टीम जानती है कि चीजें खराब हैं। वे मुख्य समस्याओं और कारणों को भी सूचीबद्ध कर सकते हैं, लेकिन परियोजना में सुधार के लिए समस्याओं और सिफारिशों की पूरी सूची चाहते हैं।

बाहरी आंतरिक मूल्यांकन की तुलना में यह अधिक औपचारिक प्रक्रिया है। ग्राहक हमेशा केवल एक ही मामले में आता है, जब सब कुछ खराब होता है - बहुत बुरा। आमतौर पर ग्राहक समझता है कि वैश्विक समस्याएं हैं, लेकिन कारणों की सही पहचान नहीं कर पाता और उन्हें घटकों में विभाजित नहीं कर पाता।

किसी बाहरी क्लाइंट के लिए आर्किटेक्चर का मूल्यांकन करना अधिक जटिल मामला है। प्रक्रिया अधिक औपचारिक होनी चाहिए. परियोजनाएँ हमेशा बड़ी और पुरानी होती हैं। उनमें बहुत सारी समस्याएँ, बग और टेढ़े-मेढ़े कोड हैं। किए गए कार्य पर एक रिपोर्ट अधिकतम कुछ हफ्तों के भीतर तैयार हो जानी चाहिए, जिसमें मुख्य समस्याएं और सुधार के लिए सिफारिशें शामिल होनी चाहिए। इसलिए, यदि हम परियोजना के बाहरी मूल्यांकन से निपटते हैं, तो आंतरिक मूल्यांकन आसान होगा। आइए सबसे कठिन मामले पर विचार करें।

उद्यम परियोजना वास्तुकला मूल्यांकन

मूल्यांकन के लिए एक विशिष्ट परियोजना बहुत सारी समस्याओं वाली एक बड़ी, पुरानी, ​​उद्यम परियोजना है। एक ग्राहक हमारे पास आता है और हमसे उसका प्रोजेक्ट ठीक करने के लिए कहता है। यह एक हिमखंड की तरह है, ग्राहक केवल अपनी समस्याओं का शीर्ष देखता है और उसे पता नहीं होता कि पानी के नीचे (कोड की गहराई में) क्या है।

समस्याएँ जिनके बारे में ग्राहक शिकायत कर सकता है और जिनके बारे में उसे जानकारी हो सकती है:

• निष्पादन मुद्दे
• प्रयोज्यता संबंधी मुद्दे
• दीर्घकालिक तैनाती
• यूनिट एवं अन्य परीक्षणों का अभाव

ऐसी समस्याएँ जिनके बारे में ग्राहक को सबसे अधिक जानकारी नहीं है, लेकिन वे परियोजना में मौजूद हो सकती हैं:

• सुरक्षा समस्याएँ
• डिज़ाइन की समस्याएँ
• गलत वास्तुकला
• एल्गोरिथम त्रुटियाँ
• अनुपयुक्त प्रौद्योगिकियाँ
• तकनीकी ऋण
• गलत विकास प्रक्रिया

औपचारिक वास्तुकला समीक्षा प्रक्रिया

यह एक औपचारिक प्रक्रिया है जिसका पालन हम एक कंपनी के रूप में करते हैं, लेकिन आप इसे अपनी कंपनी और प्रोजेक्ट के आधार पर अनुकूलित कर सकते हैं।

एक ग्राहक से अनुरोध

क्लाइंट वर्तमान प्रोजेक्ट की वास्तुकला का मूल्यांकन करने के लिए कहता है। हमारी ओर से जिम्मेदार व्यक्ति परियोजना के बारे में बुनियादी जानकारी एकत्र करता है और आवश्यक विशेषज्ञों का चयन करता है। प्रोजेक्ट के आधार पर, ये अलग-अलग विशेषज्ञ हो सकते हैं।

समाधान वास्तुविद् - मूल्यांकन और समन्वय के लिए जिम्मेदार मुख्य व्यक्ति (और अक्सर केवल एक ही)।
विशिष्ट विशेषज्ञों को ढेर करें - प्रोजेक्ट और प्रौद्योगिकियों के आधार पर .नेट, जावा, पायथन और अन्य तकनीकी विशेषज्ञ
बादल विशेषज्ञ - ये Azure, GCP या AWS क्लाउड आर्किटेक्ट हो सकते हैं।
इंफ्रास्ट्रक्चर - DevOps, सिस्टम प्रशासक, आदि।
अन्य विशेषज्ञ - जैसे बिग डेटा, मशीन लर्निंग, परफॉर्मेंस इंजीनियर, सुरक्षा विशेषज्ञ, क्यूए लीड।

परियोजना के बारे में जानकारी एकत्रित करना

आपको प्रोजेक्ट के बारे में यथासंभव अधिक जानकारी एकत्र करनी चाहिए। आप स्थिति के आधार पर विभिन्न तकनीकों का उपयोग कर सकते हैं:

• प्रश्नावली और मेल के माध्यम से संचार के अन्य तरीके। सबसे अप्रभावी तरीका.
• ऑनलाइन बैठकें.
• सूचना आदान-प्रदान के लिए विशेष उपकरण जैसे: गूगल डॉक, कॉन्फ्लुएंस, रिपॉजिटरी आदि।
• साइट पर "लाइव" बैठकें। सबसे प्रभावी और सबसे महंगा तरीका.

आपको ग्राहक से क्या मिलना चाहिए?

मूल जानकारी। परियोजना किस बारे में है? इसका उद्देश्य और मूल्य. भविष्य के लिए मुख्य लक्ष्य और योजनाएँ। व्यावसायिक लक्ष्य और रणनीतियाँ। मुख्य समस्याएं और वांछित परिणाम.

परियोजना की जानकारी. प्रौद्योगिकी स्टैक, फ्रेमवर्क, प्रोग्रामिंग भाषाएँ। ऑन-प्रिमाइसेस या क्लाउड परिनियोजन. यदि प्रोजेक्ट क्लाउड में है, तो किन सेवाओं का उपयोग किया जाता है। कौन से वास्तुशिल्प और डिज़ाइन पैटर्न का उपयोग किया गया था।

गैर-कार्यात्मक आवश्यकताएँ. सिस्टम के प्रदर्शन, उपलब्धता और उपयोग में आसानी से संबंधित सभी आवश्यकताएँ। सुरक्षा आवश्यकताएँ, आदि।

बुनियादी उपयोग के मामले और डेटा प्रवाह।

स्रोत कोड तक पहुंच. सबसे महत्वपूर्ण हिस्सा! आपको निश्चित रूप से प्रोजेक्ट बनाने के तरीके पर रिपॉजिटरी और दस्तावेज़ीकरण तक पहुंच प्राप्त करनी चाहिए।

बुनियादी ढांचे तक पहुंच. लाइव सिस्टम के साथ काम करने के लिए मंच या उत्पादन बुनियादी ढांचे तक पहुंच होना अच्छा होगा। यदि ग्राहक के पास बुनियादी ढांचे और प्रदर्शन की निगरानी के लिए उपकरण हैं तो यह एक बड़ी सफलता है। हम इन उपकरणों के बारे में अगले भाग में बात करेंगे।

अभिलेख. यदि ग्राहक के पास दस्तावेज हैं तो यह एक अच्छी शुरुआत है। यह पुराना हो सकता है, लेकिन यह अभी भी एक अच्छी शुरुआत है। दस्तावेज़ पर कभी भरोसा न करें - क्लाइंट के साथ, वास्तविक बुनियादी ढांचे और स्रोत कोड में इसका परीक्षण करें।

वास्तुकला मूल्यांकन प्रक्रिया

कोई इतने कम समय में इतनी बड़ी मात्रा में जानकारी कैसे संसाधित कर सकता है? सबसे पहले काम को समानान्तर करें।

DevOps को बुनियादी ढांचे पर ध्यान देना चाहिए। टेक कोड में ले जाता है। प्रदर्शन मेट्रिक्स देखने के लिए प्रदर्शन इंजीनियर। एक डेटाबेस विशेषज्ञ को डेटा संरचनाओं में गहराई से उतरना चाहिए।

लेकिन यह एक आदर्श मामला है जब आपके पास बहुत सारे संसाधन हों। आमतौर पर, एक से तीन लोग किसी प्रोजेक्ट का मूल्यांकन करते हैं। आप स्वयं भी अनुमान लगा सकते हैं, जो अक्सर होता है यदि आपके पास परियोजना के सभी क्षेत्रों में उचित ज्ञान और अनुभव है। इस मामले में, आपको यथासंभव सभी प्रक्रियाओं को स्वचालित करने की आवश्यकता है।

दुर्भाग्य से, आपको दस्तावेज़ को मैन्युअल रूप से पढ़ना होगा। अनुभव की सही मात्रा के साथ, आप दस्तावेज़ीकरण की गुणवत्ता को शीघ्रता से समझ सकते हैं। क्या सच है और क्या स्पष्ट रूप से वास्तविकता से मेल नहीं खाता है। कभी-कभी आप दस्तावेज़ीकरण में ऐसी वास्तुकला देख सकते हैं जो वास्तविक जीवन में कभी काम नहीं करेगी। यह आपके लिए यह सोचने के लिए एक ट्रिगर है कि परियोजना में वास्तव में यह कैसे किया गया था।

परियोजना मूल्यांकन को स्वचालित करने के लिए उपयोगी उपकरण

कोड मूल्यांकन एक सरल अभ्यास है. आप स्थैतिक कोड विश्लेषक का उपयोग कर सकते हैं जो आपको डिज़ाइन, प्रदर्शन और सुरक्षा समस्याएं दिखाएगा। यहां उनमें से कुछ हैं:

संरचना 101 एक वास्तुकार के लिए एक महान उपकरण है। यह आपको बड़ी तस्वीर, मॉड्यूल के बीच निर्भरता और रीफैक्टरिंग के संभावित क्षेत्रों को दिखाएगा। सभी अच्छे टूल की तरह, इसमें अच्छा पैसा खर्च होता है, लेकिन आप 30-दिवसीय परीक्षण संस्करण का लाभ उठा सकते हैं।

सोनारक्यूब - एक अच्छा पुराना उपकरण. स्थैतिक कोड विश्लेषण के लिए एक उपकरण। आपको 20 से अधिक प्रोग्रामिंग भाषाओं के लिए खराब कोड, बग और सुरक्षा समस्याओं की पहचान करने की अनुमति देता है।

सभी क्लाउड प्रदाताओं के पास बुनियादी ढांचे की निगरानी के उपकरण हैं। इससे आप लागत और प्रदर्शन के संदर्भ में अपने बुनियादी ढांचे की प्रभावशीलता का उचित मूल्यांकन कर सकेंगे। AWS के लिए यह है विश्वसनिय सलाहकार. Azure के लिए यह आसान है Azure सलाहकार.

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

हमेशा की तरह, अच्छे उपकरण इसके लायक हैं। मैं कुछ सशुल्क टूल की अनुशंसा कर सकता हूं। बेशक आप ओपन-सोर्स का उपयोग कर सकते हैं लेकिन इसमें आपको अधिक समय लगेगा। और यह पहले ही किया जाना चाहिए, वास्तुशिल्प मूल्यांकन प्रक्रिया के दौरान नहीं।

नई अवशेष - एप्लिकेशन प्रदर्शन का आकलन करने के लिए एक उपकरण
दातादोग - क्लाउड सिस्टम मॉनिटरिंग सेवा

सुरक्षा परीक्षण के लिए कई उपकरण उपलब्ध हैं। इस बार मैं आपको एक निःशुल्क सिस्टम स्कैनिंग टूल की अनुशंसा करूंगा।

ओडब्ल्यूएएसपी जैप - सुरक्षा मानकों के अनुपालन के लिए वेब अनुप्रयोगों को स्कैन करने के लिए एक उपकरण।

आइए सब कुछ एक साथ एक समग्र में रखें।

एक रिपोर्ट तैयार की जा रही है

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

अगला कदम। मैन्युअल रूप से या स्वचालित टूल का उपयोग करके पाए गए किसी भी मुद्दे की सूची बनाएं। एप्लिकेशन अनुभाग के अंत में बड़ी स्वतः-निर्मित रिपोर्टें रखें। पाई गई समस्याओं का संक्षिप्त और संक्षिप्त साक्ष्य होना चाहिए।
त्रुटि, चेतावनी, सूचना पैमाने पर पाई गई समस्याओं को प्राथमिकता दें। आप अपना खुद का पैमाना चुन सकते हैं, लेकिन यह आम तौर पर स्वीकृत पैमाना है।

एक सच्चे वास्तुकार के रूप में, पाई गई समस्याओं को ठीक करने के लिए अनुशंसाएँ प्रदान करना आपकी ज़िम्मेदारी है। ग्राहक को मिलने वाले सुधारों और व्यावसायिक मूल्य का वर्णन करें। बिजनेस वैल्यू कैसे दिखाएं आर्किटेक्चर रिफैक्टरिंग हमने पहले चर्चा की थी।

छोटे-छोटे पुनरावृत्तियों के साथ एक रोडमैप तैयार करें। प्रत्येक पुनरावृत्ति में पूरा करने का समय, विवरण, सुधार के लिए आवश्यक संसाधनों की मात्रा, तकनीकी मूल्य और व्यावसायिक मूल्य शामिल होना चाहिए।

हम आर्किटेक्चर मूल्यांकन पूरा करते हैं और ग्राहक को एक रिपोर्ट प्रदान करते हैं

कभी भी केवल रिपोर्ट मेल न करें. इसे बिल्कुल भी नहीं पढ़ा जा सकता है, या उचित स्पष्टीकरण के बिना पढ़ा और समझा नहीं जा सकता है। संक्षेप में, लाइव संचार लोगों के बीच गलतफहमी को खत्म करने में मदद करता है। आपको क्लाइंट के साथ एक मीटिंग शेड्यूल करनी चाहिए और सबसे महत्वपूर्ण समस्याओं पर ध्यान केंद्रित करते हुए पाई गई समस्याओं के बारे में बात करनी चाहिए। यह ग्राहक का ध्यान उन समस्याओं की ओर आकर्षित करने के लायक है जिनके बारे में उसे पता भी नहीं हो सकता है। जैसे कि सुरक्षा संबंधी मुद्दे और बताएं कि वे व्यवसाय को कैसे प्रभावित कर सकते हैं। सुधारों के साथ अपना रोडमैप दिखाएं और विभिन्न विकल्पों पर चर्चा करें जो ग्राहक के लिए अधिक उपयुक्त हों। यह समय, संसाधन, काम की मात्रा हो सकती है।

अपनी मीटिंग के सारांश के रूप में, ग्राहक को अपनी रिपोर्ट भेजें।

अंत में

वास्तुकला मूल्यांकन एक जटिल प्रक्रिया है। मूल्यांकन को सही ढंग से करने के लिए आपके पास पर्याप्त अनुभव और ज्ञान होना आवश्यक है।

केवल एक सप्ताह में ग्राहक को उसके और उसके व्यवसाय के लिए उपयोगी परिणाम प्रदान करना संभव है। भले ही आप इसे अकेले करें.

मेरे अनुभव के आधार पर, कई सुधार बीच में ही डाउनलोड किए गए, और कभी-कभी कभी शुरू ही नहीं हुए। जिन लोगों ने अपने लिए सुनहरा मतलब चुना और उन सुधारों का केवल एक हिस्सा बनाया जो न्यूनतम श्रम लागत के साथ व्यवसाय के लिए सबसे उपयोगी थे, उनके उत्पाद की गुणवत्ता में काफी सुधार हुआ। जिन लोगों ने कुछ नहीं किया, वे कुछ वर्षों के बाद परियोजना को पूरी तरह से बंद कर सकते हैं।

आपका लक्ष्य ग्राहक को न्यूनतम कीमत पर अधिकतम सुधार दिखाना है।

अनुभाग से अन्य लेख स्थापत्य आप अपने खाली समय में पढ़ सकते हैं।

मैं आपके स्वच्छ कोड और अच्छे वास्तुशिल्प निर्णयों की कामना करता हूं।

हमारा फेसबुक ग्रुप - सॉफ्टवेयर वास्तुकला और विकास.

स्रोत: www.habr.com