🙀 👴🏾 🙍🏽 प्रति सप्ताह कोड की 100,000 लाइनों को कैसे पढ़ें और ठीक करें ⛵️ 🤪 ☘️

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

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

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

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

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

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

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

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

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

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

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

एक उद्यम परियोजना की वास्तुकला का आकलन

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

समस्याओं कि ग्राहक के बारे में शिकायत कर सकते हैं और उनके बारे में पता कर सकते हैं:

प्रदर्शन के कारण
प्रयोज्यता के मुद्दे
लंबी तैनाती
यूनिट और अन्य परीक्षणों की कमी

जिन समस्याओं की सबसे अधिक संभावना ग्राहक को नहीं है, लेकिन वे परियोजना में उपस्थित हो सकते हैं:

सुरक्षा की समस्या
डिजाइन मुद्दों
गलत वास्तुकला
एल्गोरिदमिक त्रुटियां
अनुचित तकनीक
तकनीकी ऋण
अमान्य विकास प्रक्रिया

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

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

ग्राहक अनुरोध

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

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

परियोजना सूचना संग्रह

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

मेल के माध्यम से प्रश्नावली और संचार के अन्य साधन। सबसे अयोग्य तरीका।
ऑनलाइन मीटिंग।
सूचनाओं के आदान-प्रदान के लिए विशेष उपकरण जैसे: Google doc, Confluence, repositories, आदि।
जगह में "लाइव" बैठकें। सबसे प्रभावी और सबसे महंगा तरीका।

क्लाइंट से क्या प्राप्त करना चाहिए?

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

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

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

बेसिक जूसकी और डेटा स्ट्रीम।

स्रोत कोड तक पहुंच । सबसे महत्वपूर्ण हिस्सा! आपको निश्चित रूप से एक परियोजना को इकट्ठा करने के तरीके पर रिपॉजिटरी और प्रलेखन तक पहुंच प्राप्त करनी चाहिए।

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

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

आर्किटेक्चर आकलन प्रक्रिया

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

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

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

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

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

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

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

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

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

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

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

नई अवशेष - अनुप्रयोग प्रदर्शन मूल्यांकन उपकरण
डेटाडॉग - क्लाउड-आधारित बहन निगरानी सेवा

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

OWASP ZAP सुरक्षा मानकों के अनुपालन के लिए वेब अनुप्रयोगों को स्कैन करने के लिए एक उपकरण है।

यह सब एक साथ डालें।

हम एक रिपोर्ट तैयार कर रहे हैं

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

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

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

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

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

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

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

आखिरकार

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

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

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

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

अनुभाग के अन्य लेख आपके अवकाश पर पढ़े जा सकते हैं।

मैं आपको साफ कोड और अच्छे वास्तु समाधानों की कामना करता हूं।

हमारा facebook group Software Architecture and Development है ।

प्रति सप्ताह कोड की 100,000 लाइनों को कैसे पढ़ें और ठीक करें