⏯️ 🤪 🎏 संघर्ष पर डिजाइन 👨‍👦 👨‍👨‍👧‍👧 🖖🏿

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

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

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

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

उपकरण

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

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

मैक्रो

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

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

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

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

उसी समय, आप फ्रेम के अंदर जितने चाहें उतने अन्य डाल सकते हैं, अगर आपके पिरामिड में केवल तर्क है।

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

पैटर्न्स

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

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

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

मेज का जादू

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

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

फ़िल्टरिंग (सशुल्क प्लगइन)

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

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

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

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

क्रमबद्ध (सशुल्क प्लगइन)

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

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

सारांश सारणी (सशुल्क प्लगइन)

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

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

स्वाभाविक रूप से, आप एक साथ कई मानदंडों द्वारा समूह बना सकते हैं, सभी विशेषताएं प्रलेखन में पाई जा सकती हैं ।

चार्ट्स (सशुल्क प्लगइन)

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

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

एकत्रीकरण में आसानी

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

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

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

पृष्ठ गुण

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

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

रिपोर्ट

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

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

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

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

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

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

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

अनुदेश पुस्तिका

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

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

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

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

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

पानी के नीचे की चट्टानें

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

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

गैर-उत्पाद प्रलेखन संग्रहीत करने का एक उदाहरण

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

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

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

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

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

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

निष्कर्ष

कोई भी दस्तावेज रखें ताकि यह शर्मनाक न हो, और उपयोगकर्ता विशेष रूप से आहत न हों!

मुझे वास्तव में उम्मीद है कि लेख उपयोगी होगा और दुनिया के सभी दस्तावेज क्रम में होंगे।

संघर्ष पर डिजाइन