👋🏾 🤟🏽 💮 PlantUML - सब कुछ व्यापार विश्लेषकों को सॉफ्टवेयर प्रलेखन में चार्ट बनाने की आवश्यकता है 🐄 💭 ⏹️

परिचय

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

पाठ के इस समुद्र में चार्ट रचनात्मकता का घूंट हैं। इस लेख में चार्ट पर चर्चा की जाएगी। अधिक सटीक - प्लांट यूएमएल के बारे में - मेरे दृष्टिकोण से, फिलहाल उन्हें बनाने के लिए सबसे पर्याप्त उपकरण।

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

start :   ; if (?) then () :  ; if (?) then () else () :  ; endif :  ////; else () stop endif stop

लोकप्रियता के बावजूद, Habré पर बहुत कम लेख हैं जो इस उपकरण के व्यावहारिक अनुप्रयोग के बारे में बात करते हैं। यह मुझे लगता है कि प्लांट यूएमएल इस तरह के ध्यान की कमी के लायक नहीं है।

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

क्यों PlantUML

मेरे दृष्टिकोण से, आरेख बनाते समय, यह निम्न मानदंडों पर ध्यान केंद्रित करने के लिए समझ में आता है: (1) आरेख कम या कम छोटा होना चाहिए, (2) आरेख को अधिक या कम मानक संकेतन का उपयोग करना चाहिए, और (3) परियोजना के प्रलेखन के दृष्टिकोण से आरेख कम या कम सुविधाजनक होना चाहिए। ।

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

फिर भी, मेरे लिए, ये मानदंड शुरुआती बिंदु हैं जहां से आप आरेख के साथ आना शुरू करते हैं। आगे ... यह कैसे जाता है

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

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

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

प्लांटयूएमएल के आगमन के साथ, स्थिति मौलिक रूप से बदल गई है।

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

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

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

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

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

प्लांट यूएमएल टिप्स

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

चार्ट बनाने के लिए कहाँ?

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

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

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

यानी प्रत्येक आरेख हमेशा दो फ़ाइलों से मेल खाती है, एक पाठ फ़ाइल (आरेख का एक पाठ विवरण के साथ), और दूसरा ग्राफिक (चित्र के साथ एक चित्र)।

चूंकि हम लंबे समय से Asciidoctor की मदद से सभी प्रलेखन कर रहे हैं (यह आश्चर्यजनक है कि Microsoft Word को कैसे मना करना आसान बना सकता है, लेकिन यह एक अलग लेख का विषय है), हम चित्रों को लिंक के माध्यम से सम्मिलित करते हैं। इस तकनीक के साथ तस्वीर बदलने के लिए, बस टेक्स्ट विवरण खोलें, इसे बदलें और सहेजें। आपको क्लिपबोर्ड के माध्यम से निर्यात या प्रतिलिपि संचालन करने की आवश्यकता नहीं है।

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

छपाई के लिए चार्ट तैयार करना

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

छाया को हटाने के लिए, जो आमतौर पर मुद्रित उपस्थिति को भी खराब कर देता है, झूठा पैरामीटर को छायांकित करने वाले स्किनपरम का उपयोग किया जाता है।

इसके अलावा, एक काले और सफेद प्रिंटर पर एक चार्ट प्रिंट करने के लिए, यह वांछनीय है कि इसमें हाफ़टोन नहीं है। भूरे और पीले रंग का उपयोग करने वाली एक रंग योजना आमतौर पर छपाई के लिए उपयुक्त नहीं होती है। सौभाग्य से, PlantUML आपको इस्तेमाल किए गए रंगों को निर्दिष्ट करने की अनुमति देता है। निम्न विकल्प, उदाहरण के लिए, एक काले और सफेद पैलेट में एक घटक आरेख प्रदर्शित करें। मोनोक्रोम आरेख पीढ़ी ( स्किनपरम मोनोक्रोम ट्रू ) के लिए एक विशेष पैरामीटर है, लेकिन यह केवल रंग को हटा देता है, हाफ़टोन रहता है।

 skinparam component { borderColor black backgroundColor white ArrowColor black }

अधिकांश मापदंडों की एक सूची यहां दी गई है । यदि आप सभी मापदंडों का अध्ययन करना चाहते हैं, तो आप java -jar plantuml.jar -language कमांड का उपयोग कर सकते हैं।

तत्वों की सापेक्ष व्यवस्था

बाएं से दाएं दिशा पैरामीटर चार्ट तत्वों को बाएं से दाएं की ओर खींचने का कारण बनता है। बहुत स्पष्ट नहीं है, लेकिन, उदाहरण के लिए, एक घटक आरेख के लिए, इसका मतलब है कि घटकों को बाईं ओर इकट्ठा किया जाएगा, और दाईं ओर इंटरफेस।
```
 component " 1" as c1 component " 2" as c2 interface " 1" as i1 c1 --() i1 c2 --( i1 
```
उच्च स्तर के तत्वों के साथ समूह बनाना।

निम्नलिखित आंकड़े में, प्लांटयूएमएल ने घटकों को वितरित किया है ताकि कम लाइन चौराहे हों। घटकों का यह क्रम अवांछनीय हो सकता है यदि हम चाहते हैं कि घटकों को क्रम में प्रदर्शित किया जाए।
```
 component " 1" as c1 component " 2" as c2 component " 3" as c3 interface " 1" as i1 c1 --() i1 c2 --( i1 interface " 2" as i2 c1 --() i2 c3 --( i2 
```
यदि हम दूसरे और तीसरे घटकों को समूहित करते हैं, तो हम प्राप्त करेंगे कि घटकों को क्रम में व्यवस्थित किया गया है।
```
 component " 1" as c1 component " 1" { component " 2" as c2 component " 3" as c3 } interface " 1" as i1 c1 --() i1 c2 --( i1 interface " 2" as i2 c1 --() i2 c3 --( i2 
```
घटकों का क्रम। एक बल्कि विवादास्पद दृष्टिकोण, लेकिन यह काम करता है। निम्नलिखित उदाहरण में, घटक 2 को पहले प्रदर्शित किया गया है, जैसा कि विनिर्देशन में यह पहले सूचीबद्ध है।
```
 component " 2" as c2 component " 1" as c1 interface " 1" as i1 c1 --() i1 c2 --( i1 
```

प्लांटयूएमएल में तीर दिशाओं को इंगित करने की क्षमता भी है। उदाहरण के लिए, यह इंगित करने के लिए कि तीर घटक 1 (c1) से इंटरफ़ेस 1 (i1) तक बाएँ से दाएँ जाता है, आपको तीर के विनिर्देशन में अक्षर "r" को निर्दिष्ट करने की आवश्यकता है: c1 -r- () i1 । निम्न उदाहरण स्पष्ट रूप से इंगित करता है कि घटक 1 से इंटरफ़ेस 1 तक तीर बाएं से दाएं और घटक दो से समान इंटरफ़ेस से दाएं से बाएं जाता है।

 component " 1" as c1 component " 2" as c2 interface " 1" as i1 c1 -r-() i1 c2 -l-( i1

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

लेबल तत्वों

मल्टी-लाइन टेक्स्ट और विकी मार्कअप

प्लांटयूएमएल तत्वों में पाठ को स्वरूपित करने के लिए कुछ अच्छे उपकरण प्रदान करता है।

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

बड़े पाठ बनाने का सबसे आसान तरीका \ n वर्ण का उपयोग करना है। इस मामले में, आप पाठ स्वरूपण वर्ण (बोल्ड, इटैलिक, आदि) का भी उपयोग कर सकते हैं

 component "** 1** \n       \n //****// \n* //// 1 \n* // 2//" as c1

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

 component c1 [ ** 1** ====       ..//****//.. * //// 1 * // 2// ] note left      .... ** 1** ====       ..//****//.. * //// 1 * // 2// end note

जैसा कि हम देख सकते हैं, इस सिंटैक्स का उपयोग करके विभाजन लाइनों को जोड़ना संभव हो जाता है। ध्यान दें कि यहां एक नोट जोड़ा गया है जो घटक के समान पाठ प्रदर्शित करता है। उसी समय, नोट में सूची को एक सूची के रूप में प्रदर्शित किया जाता है, और घटक में, "*" प्रतीक के माध्यम से पाठ के रूप में। दुर्भाग्य से, सूचियाँ और तालिकाएँ घटकों में काम नहीं करती हैं। हालांकि वे, उदाहरण के लिए, गतिविधि (गतिविधि आरेख) में प्रतिनिधित्व करने वाले तत्वों में काम करते हैं।

प्रतीक का उपयोग करना

प्लांटयूएमएल आइकन का उपयोग करने के कई तरीकों का समर्थन करता है। उन सभी की कुछ सीमाएँ हैं।

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

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

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

 '       !define ICONURL https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/v2.0.0 !includeurl ICONURL/common.puml !includeurl ICONURL/font-awesome-5/user_cog.puml !includeurl ICONURL/font-awesome-5/user_check.puml !define _CS scale=0.4 !define _user_cog <$user_cog{_CS}> !define _user_check <$user_check{_CS}> ' legend ..** **.. _user_cog —  _user_check —  endlegend '   state " " as prepare_doc [*] --> prepare_doc state "  " as check_doc prepare_doc --> check_doc : _user_cog \n  \n  check_doc --> prepare_doc : _user_check \n  \n  state " " as ready_doc check_doc --> ready_doc: _user_check \n   \n<U+00AB><U+00BB>

कुछ आइकन सीधे प्लांटयूएमएल में निर्मित होते हैं, हालांकि मैं बाहरी पुस्तकालयों का उपयोग करना पसंद करता हूं। विशेष रूप से, इस उदाहरण के आइकन विस्मयकारी v5 पुस्तकालय में समाहित हैं, और वर्तमान लेख (संस्करण 1.2018.08) लिखने के समय, केवल Awesome v4 पुस्तकालय प्लांटयूएमएल में बनाया गया है।

उद्धरण का उपयोग करना

प्लांट यूएमएल का उपयोग करने के लिए यह सरल प्रश्न प्रतीत होता है। उद्धरणों की कमी अव्यवसायिक और हास्यास्पद लगती है।

PlantUML उद्धरणों का उपयोग करने के कई तरीकों का समर्थन करता है। लेकिन खोजों के परिणामस्वरूप, मुझे केवल एक ही मिला जो हमेशा काम करता है, अच्छा पुराना स्क्रैप: रूसी उद्धरण खोलने के लिए - <U + 00AB>, उद्धरण चिह्नों के लिए - <U + 00BB>, सार्वभौमिक लोगों के लिए - <U + 0022>।

आरेख में खो जाने के लिए कैसे नहीं

गतिविधि आरेख में वाक्यविन्यास इतना सुविधाजनक है कि क्योंकि भ्रमित होना मुश्किल है यह आरेख के विवरण की तुलना में एल्गोरिथ्म के विवरण की तरह है। लेकिन यहां अन्य आरेखों में: राज्य, घटक, परिनियोजन, उपयोग के मामले, कक्षाएं और अन्य, यह भ्रमित होने में काफी आसान है।

दो सरल नियम मुझे भ्रमित न होने में मदद करते हैं।

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

निष्कर्ष

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

PlantUML - सब कुछ व्यापार विश्लेषकों को सॉफ्टवेयर प्रलेखन में चार्ट बनाने की आवश्यकता है