कैसे एक सर्वव्यापी भाषा दस्तावेज़ करने के लिए?


14

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

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

अन्य कंपनियां सर्वव्यापी भाषा का दस्तावेज कैसे बनाती हैं? क्या यह सिर्फ एक विकि-शैली शब्दकोश है? क्या इस उद्देश्य के लिए कुछ उपकरण है?


1
यह एक अच्छी शुरुआत है: Thepaulrayner.com/blog/2013/05/07/… । मैं विशेष रूप से इस मार्ग को पसंद करता हूं: "महत्वपूर्ण बात यह नहीं होनी चाहिए कि डोमेन का दस्तावेजीकरण किया गया है, यह है कि यह समझ में आता है, और यह समझ सॉफ्टवेयर विकसित करने से जुड़े सभी लोगों के बीच साझा की जाती है।"
रॉबर्ट हार्वे

वाह - क्या कमाल का सवाल है। अगर मेरे पास यह सवाल होता, तो मैं EventStorming में देखता, और देखता कि क्या उस प्रक्रिया के परिणामों का दस्तावेजीकरण करने का एक समझदार तरीका है।
VoiceOfUnreason

जवाबों:


4

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

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

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

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

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

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

जब यह डॉक्यूमेंटेशन स्ट्रक्चर किया जाता है और मैं अधिक विस्तृत सिस्टम स्पेसिफिकेशंस पर जाता हूं, तो मैं बस परिदृश्यों के IA और UL परिभाषाओं का उल्लेख कर सकता हूं, जैसे "घटक A सिस्टम B के साथ इंप्लांटेशन C (IA परिदृश्य लिंक) का समर्थन करने के बारे में जानकारी पास करके एकीकरण लागू करता है। Z (UL लिंक) "।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.