एक हप्तामा कोडको 100,000 लाइनहरू कसरी पढ्ने र सच्याउने

सुरुमा यो ठूलो र पुरानो परियोजना बुझ्न सधैं गाह्रो छ। वास्तुकला एक वास्तुकार मूल्यांकन को गतिविधिहरु मध्ये एक हो। सामान्यतया तपाईंले ठूला, पुराना परियोजनाहरूसँग काम गर्नुपर्छ, र परिणामहरू एक हप्तामा डेलिभर गरिनुपर्छ।

एक हप्तामा 100k वा थप लाइनहरूको कोडको प्रोजेक्ट कसरी मूल्याङ्कन गर्ने जबकि अझै पनि ग्राहकका लागि साँच्चै उपयोगी नतिजाहरू प्रदान गर्दै।

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

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

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

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

त्यहाँ दुई प्रकारका वास्तुकला मूल्याङ्कन छन्।

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

1. टोलीले सोच्दछ कि उनीहरूको परियोजना उत्तम छ र यो शंकास्पद छ। हामीसँग त्यस्ता केसहरू छन्, र प्रायः त्यस्ता परियोजनाहरूमा सबै कुरा आदर्शबाट टाढा छ।
2. टोली आफ्नो परियोजना र तिनीहरूको समाधान परीक्षण गर्न चाहन्छ।
3. टोलीलाई थाहा छ चीजहरू खराब छन्। तिनीहरूले मुख्य समस्या र कारणहरू पनि सूचीबद्ध गर्न सक्छन्, तर परियोजना सुधार गर्न समस्या र सिफारिसहरूको पूर्ण सूची चाहन्छन्।

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

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

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

मूल्याङ्कन गर्नको लागि एक सामान्य परियोजना भनेको धेरै समस्याहरू भएको ठूलो, पुरानो, उद्यम परियोजना हो। एक ग्राहक हामीकहाँ आउँछन् र हामीलाई आफ्नो प्रोजेक्ट ठीक गर्न सोध्छन्। यो आइसबर्ग जस्तै हो, ग्राहकले आफ्नो समस्याको टिप मात्र देख्छ र पानी मुनि के छ (कोडको गहिराइमा) थाहा छैन।

समस्याहरू जुन ग्राहकले गुनासो गर्न सक्छ र यस बारे सचेत हुन सक्छ:

• कार्यसम्पादन मुद्दाहरू
• उपयोगिता समस्याहरू
• दीर्घकालीन परिनियोजन
• युनिट र अन्य परीक्षणको अभाव

समस्याहरू जुन ग्राहकलाई सम्भवतः थाहा छैन, तर तिनीहरू परियोजनामा ​​उपस्थित हुन सक्छन्:

• सुरक्षा समस्याहरू
• डिजाइन समस्याहरू
• गलत वास्तुकला
• एल्गोरिदमिक त्रुटिहरू
• अनुपयुक्त प्रविधिहरू
• प्राविधिक ऋण
• गलत विकास प्रक्रिया

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

यो एक औपचारिक प्रक्रिया हो जुन हामीले कम्पनीको रूपमा पछ्याउँछौं, तर तपाइँ यसलाई तपाइँको कम्पनी र परियोजनाको आधारमा अनुकूलित गर्न सक्नुहुन्छ।

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

ग्राहकले हालको परियोजनाको वास्तुकलाको मूल्याङ्कन गर्न सोध्छ। हाम्रो पक्षमा जिम्मेवार व्यक्तिले परियोजनाको बारेमा आधारभूत जानकारी सङ्कलन गर्दछ र आवश्यक विशेषज्ञहरू चयन गर्दछ। परियोजनामा ​​निर्भर गर्दै, यी फरक विशेषज्ञहरू हुन सक्छन्।

समाधान आर्किटेक्ट - मूल्याङ्कन र समन्वयका लागि जिम्मेवार मुख्य व्यक्ति (र प्रायः एक मात्र)।
स्टक विशिष्ट विशेषज्ञहरू - नेट, जाभा, पाइथन, र परियोजना र प्रविधिहरूमा निर्भर अन्य प्राविधिक विशेषज्ञहरू
क्लाउड विशेषज्ञहरू - यी Azure, GCP वा AWS क्लाउड आर्किटेक्टहरू हुन सक्छन्।
पूर्वाधार - DevOps, प्रणाली प्रशासक, आदि।
अन्य विज्ञहरू - जस्तै ठूलो डाटा, मेसिन लर्निङ, प्रदर्शन इन्जिनियर, सुरक्षा विशेषज्ञ, QA नेतृत्व।

परियोजना बारे जानकारी सङ्कलन

तपाईंले परियोजनाको बारेमा सकेसम्म धेरै जानकारी सङ्कलन गर्नुपर्छ। तपाईं परिस्थितिको आधारमा विभिन्न प्रविधिहरू प्रयोग गर्न सक्नुहुन्छ:

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

तपाईले ग्राहकबाट के पाउनु पर्छ?

आधारभूत जानकारी। परियोजना के बारे मा छ? यसको उद्देश्य र मूल्य। भविष्यका लागि मुख्य लक्ष्य र योजनाहरू। व्यापार लक्ष्य र रणनीतिहरू। मुख्य समस्या र इच्छित परिणाम।

परियोजना जानकारी। टेक्नोलोजी स्ट्याक, फ्रेमवर्क, प्रोग्रामिङ भाषाहरू। अन-प्रिमाइस वा क्लाउड डिप्लोइमेन्ट। यदि परियोजना क्लाउडमा छ भने, कुन सेवाहरू प्रयोग गरिन्छ। कुन वास्तुकला र डिजाइन ढाँचाहरू प्रयोग गरियो।

गैर-कार्यात्मक आवश्यकताहरू। कार्यसम्पादन, उपलब्धता, र प्रणालीको प्रयोगमा सहजतासँग सम्बन्धित सबै आवश्यकताहरू। सुरक्षा आवश्यकताहरू, आदि।

आधारभूत प्रयोग केसहरू र डाटा प्रवाह।

स्रोत कोडमा पहुँच। सबैभन्दा महत्त्वपूर्ण भाग! तपाईंले निश्चित रूपमा भण्डारहरू र परियोजना कसरी निर्माण गर्ने कागजातहरूमा पहुँच प्राप्त गर्नुपर्छ।

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

दस्तावेज। यदि ग्राहकसँग कागजात छ भने यो राम्रो सुरुवात हो। यो पुरानो हुन सक्छ, तर यो अझै राम्रो सुरुवात हो। कागजातमा कहिल्यै विश्वास नगर्नुहोस् - ग्राहकसँग वास्तविक पूर्वाधार र स्रोत कोडमा परीक्षण गर्नुहोस्।

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

यति छोटो समयमा यति ठूलो मात्रामा सूचना कसरी प्रशोधन गर्न सकिन्छ? सबै भन्दा पहिले, काम समानांतर।

DevOps ले पूर्वाधार हेर्नु पर्छ। कोडमा प्राविधिक नेतृत्व। प्रदर्शन मेट्रिक्स हेर्न प्रदर्शन इन्जिनियर। डाटाबेस विशेषज्ञले डाटा संरचनाहरूमा गहिरो खन्नुपर्छ।

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

दुर्भाग्यवश, तपाईंले कागजातहरू म्यानुअल रूपमा पढ्नु पर्छ। अनुभवको सही मात्राको साथ, तपाइँ द्रुत रूपमा कागजातको गुणस्तर बुझ्न सक्नुहुन्छ। के सत्य हो र के स्पष्ट रूपमा वास्तविकता संग मेल खाँदैन। कहिलेकाहीँ तपाईंले कागजातमा वास्तुकला देख्न सक्नुहुन्छ जुन वास्तविक जीवनमा कहिल्यै काम गर्दैन। यो परियोजनामा ​​वास्तविकतामा कसरी गरियो भन्ने बारे सोच्नको लागि यो ट्रिगर हो।

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

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

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

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

सबै क्लाउड प्रदायकहरूसँग पूर्वाधार निगरानी उपकरणहरू छन्। यसले तपाईंलाई लागत र कार्यसम्पादनको सन्दर्भमा तपाईंको पूर्वाधारको प्रभावकारिताको उचित मूल्याङ्कन गर्न अनुमति दिनेछ। AWS को लागि यो हो विश्वस्त सल्लाहकार। Azure को लागि यो सजिलो छ Azure सल्लाहकार.

अतिरिक्त कार्यसम्पादन अनुगमन र लगिङले सबै तहमा कार्यसम्पादन मुद्दाहरू फेला पार्न मद्दत गर्नेछ। अप्रभावी प्रश्नहरूको साथ डाटाबेसबाट सुरु गर्दै, ब्याकइन्ड र फ्रन्टएन्डसँग समाप्त हुन्छ। यदि क्लाइन्टले यी उपकरणहरू पहिले स्थापना गरेको छैन भने पनि, तपाइँ तिनीहरूलाई अवस्थित प्रणालीमा कार्यसम्पादन समस्याहरू पहिचान गर्नको लागि द्रुत रूपमा एकीकृत गर्न सक्नुहुन्छ।

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

नयाँ सम्बन्ध - अनुप्रयोग प्रदर्शन मूल्याङ्कन को लागी एक उपकरण
डाटाडोग - क्लाउड प्रणाली निगरानी सेवा

सुरक्षा परीक्षणका लागि धेरै उपकरणहरू उपलब्ध छन्। यस पटक म तपाईंलाई नि:शुल्क प्रणाली स्क्यानिङ उपकरण सिफारिस गर्नेछु।

OWASP ZAP - सुरक्षा मापदण्डहरूको अनुपालनको लागि वेब अनुप्रयोगहरू स्क्यान गर्ने उपकरण।

सबै कुरालाई एकै पूरैमा मिलाएर राखौं।

प्रतिवेदन तयार गर्दै

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

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

एक साँचो वास्तुकारको रूपमा, फेला परेका समस्याहरू सुधार गर्न सिफारिसहरू प्रदान गर्नु तपाईंको जिम्मेवारी हो। ग्राहकले प्राप्त गर्ने सुधार र व्यापार मूल्यको वर्णन गर्नुहोस्। बाट व्यापार मूल्य कसरी देखाउने वास्तुकला रिफ्याक्टरिंग हामीले पहिले छलफल गर्यौं।

साना पुनरावृत्तिहरूको साथ रोडम्याप तयार गर्नुहोस्। प्रत्येक पुनरावृत्तिमा पूरा गर्न समय, विवरण, सुधारको लागि आवश्यक स्रोतहरूको मात्रा, प्राविधिक मूल्य र व्यापार मूल्य समावेश हुनुपर्छ।

हामी वास्तुकला मूल्याङ्कन पूरा गर्छौं र ग्राहकलाई रिपोर्ट प्रदान गर्दछौं

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

तपाईंको बैठकको सारांशको रूपमा, तपाईंको रिपोर्ट ग्राहकलाई पठाउनुहोस्।

निष्कर्षमा

वास्तुकला मूल्यांकन एक जटिल प्रक्रिया हो। मूल्याङ्कन ठीकसँग गर्नको लागि तपाईसँग पर्याप्त अनुभव र ज्ञान हुनु आवश्यक छ।

केवल एक हप्तामा ग्राहकलाई उसको र उसको व्यवसायको लागि उपयोगी नतिजाहरू प्रदान गर्न सम्भव छ। एक्लै गरे पनि ।

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

तपाईको लक्ष्य भनेको न्यूनतम मूल्यको लागि ग्राहकलाई अधिकतम सुधारहरू देखाउनु हो।

खण्डबाट अन्य लेखहरू वास्तुकला तपाईं आफ्नो फुर्सद मा पढ्न सक्नुहुन्छ।

म तपाईलाई सफा कोड र राम्रो वास्तु निर्णयहरू चाहन्छु।

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

स्रोत: www.habr.com