🥇संगम में डिजाइनिंग

सभी को नमस्कार!

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

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

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

उपकरण

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

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

मैक्रो

कॉन्फ्लुएंस का लगभग सारा जादू मैक्रोज़ से आता है। बहुत सारे मैक्रोज़ हैं, और उन्हें एक-दूसरे के साथ जोड़ा जा सकता है। उन्हें भुगतान या मुफ़्त किया जा सकता है; नीचे उनके लिए दस्तावेज़ीकरण के लिंक के साथ मैक्रोज़ के विभिन्न उदाहरण होंगे।

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

यदि कोई मैक्रो स्व-निहित है, अर्थात उसे अपने अंदर कुछ और डालने की आवश्यकता नहीं है, तो यह एक ब्लॉक की तरह दिखता है।

यदि मैक्रो को काम करने के लिए इसके अंदर कुछ रखने की आवश्यकता होती है, तो यह एक फ्रेम की तरह दिखता है।

साथ ही, आप जितने चाहें उतने अन्य लोगों को एक फ्रेम के अंदर रख सकते हैं, जब तक कि आपके पिरामिड में तर्क मौजूद है।

प्रत्येक मैक्रो का एक पूर्वावलोकन होता है: यह तुरंत दिखाता है कि आपने मैक्रो को सही ढंग से भरा और कॉन्फ़िगर किया है या नहीं।

टेम्पलेट्स

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

फिर टेम्प्लेट में मौजूद सभी सामग्री को बनाए गए पेज पर जोड़ दिया जाएगा।

कोई भी व्यक्ति टेम्प्लेट से पेज बना सकता है, लेकिन ऐसा केवल वे ही कर सकते हैं जिनके पास टेम्प्लेट बनाने या संपादित करने का अधिकार है। आप टेम्पलेट में अतिरिक्त निर्देश जोड़ सकते हैं कि पेज का रखरखाव कैसे किया जाना चाहिए।

टेबलों का जादू

दरअसल, एक तकनीकी विशेषज्ञ के रूप में, मुझे टेबल बहुत पसंद हैं और मैं उनमें लगभग कोई भी जानकारी लपेट सकता हूं (हालांकि यह हमेशा प्रभावी नहीं होता है)। टेबल स्वयं स्पष्ट, संरचित, स्केलेबल, जादुई हैं!

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

फ़िल्टरिंग (भुगतान किया गया प्लगइन)

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

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

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

यह ध्यान देने योग्य है कि बड़ी तालिकाओं को फ़िल्टर करने से सिस्टम प्रदर्शन और पेज लोडिंग समय प्रभावित हो सकता है, इसलिए फ़िल्टर में एक बड़ी तालिका डालना एक अस्थायी बैसाखी है; एक ऐसी प्रक्रिया बनाना बेहतर है जिसमें लोगों को विशाल, अपठनीय तालिकाएँ नहीं बनानी पड़े (एक प्रक्रिया का उदाहरण लेख के अंत में होगा)।

सॉर्टिंग (भुगतान किया गया प्लगइन)

जादुई मैक्रो का उपयोग करना "टेबल फ़िल्टर" आप किसी भी कॉलम पर डिफ़ॉल्ट सॉर्ट सेट कर सकते हैं और पंक्तियों को क्रमांकित कर सकते हैं। या फ़िल्टर मैक्रो में सम्मिलित तालिका के किसी भी कॉलम पर क्लिक करें, और उस कॉलम के अनुसार सॉर्टिंग होगी।

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

पिवोट टेबल (भुगतान किया गया प्लगइन)

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

उदाहरण के लिए: आपके पास एक तालिका है जो सभी कर्मचारियों से डेटा एकत्र करती है - वे भौगोलिक रूप से कहां स्थित हैं और वे किस पद पर हैं। यह गणना करने के लिए कि प्रत्येक शहर में कितने लोग हैं, आपको पिवोटटेबल मैक्रो में उस पंक्ति का चयन करना होगा जो डेटा (स्थान) और ऑपरेशन प्रकार (अतिरिक्त) को एकत्रित करती है।

स्वाभाविक रूप से, आप एक साथ कई मानदंडों के आधार पर समूह बना सकते हैं, सभी संभावनाओं को देखा जा सकता है दस्तावेज़ीकरण में.

चार्ट (भुगतान किया गया प्लगइन)

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

स्वाभाविक रूप से, इस मैक्रो में सेटिंग्स भी हैं। किसी भी मैक्रो के दस्तावेज़ीकरण का लिंक उस मैक्रो के संपादन मोड में पाया जा सकता है।

आसान एकत्रीकरण

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

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

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

पृष्ठ गुण

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

आईडी पर ध्यान दें - इसे अलग-अलग पृष्ठों पर संपत्तियों के विभिन्न समूहों (या एक पृष्ठ पर संपत्तियों के विभिन्न समूहों) को निर्दिष्ट करने के लिए सेट करना सुविधाजनक है।

रिपोर्ट

आप टैग का उपयोग करके रिपोर्ट एकत्र कर सकते हैं। उदाहरण के लिए, मैक्रो "सामग्री रिपोर्ट" टैग के एक विशिष्ट सेट के साथ सभी पृष्ठों को एकत्रित करता है।

लेकिन एक अधिक दिलचस्प रिपोर्ट मैक्रो है "पेज गुण रिपोर्ट". यह टैग के एक निश्चित सेट के साथ सभी पृष्ठों को भी एकत्रित करता है, लेकिन यह केवल उनकी एक सूची प्रदर्शित नहीं करता है, बल्कि एक तालिका बनाता है (क्या आप लेख की शुरुआत के साथ कनेक्शन पकड़ते हैं?), जिसमें कॉलम पृष्ठ हैं संपत्ति कुंजियाँ.

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

कॉन्फ़िगर करते समय, आप रिपोर्ट से कुछ कॉलम हटा सकते हैं, एक डिफ़ॉल्ट स्थिति या प्रदर्शित रिकॉर्ड की संख्या सेट कर सकते हैं। आप केवल अपनी आवश्यक जानकारी देखने के लिए पेज प्रॉपर्टी आईडी भी सेट कर सकते हैं।

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

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

अंतिम प्रक्रिया

अनुदेश

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

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

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

फिर अंतिम प्रक्रिया इस तरह दिखेगी:

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

नुकसान

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

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

गैर-उत्पाद दस्तावेज़ भंडारण का उदाहरण

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

मैं आपको किसी टीम के बारे में जानकारी बनाए रखने की हमारी प्रक्रिया का एक उदाहरण देता हूँ।

हमने टीम के प्रत्येक व्यक्ति के लिए एक कर्मचारी कार्ड बनाने का निर्णय लिया। तदनुसार, हमारे पास एक टेम्पलेट है जिसके अनुसार प्रत्येक नया व्यक्ति अपने लिए यह कार्ड बनाता है और इसमें सभी व्यक्तिगत जानकारी रखता है।

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

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

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

निष्कर्ष

किसी भी दस्तावेज़ को इस प्रकार बनाए रखें कि उसमें कोई शर्मिंदगी न हो, और इससे उपयोगकर्ताओं को असहनीय पीड़ा न हो!

मैं वास्तव में आशा करता हूं कि लेख उपयोगी होगा और दुनिया के सभी दस्तावेज़ों में ऑर्डर आएगा।

स्रोत: www.habr.com

संगम में डिजाइन