Oracle
 sql >> डेटाबेस >  >> RDS >> Oracle

डेटाबेस का दस्तावेजीकरण कैसे करें

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

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

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

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

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



  1. Database
  2.   
  3. Mysql
  4.   
  5. Oracle
  6.   
  7. Sqlserver
  8.   
  9. PostgreSQL
  10.   
  11. Access
  12.   
  13. SQLite
  14.   
  15. MariaDB
  1. Oracle SQL डेवलपर में XML फ़ाइल कैसे आयात करें?

  2. Oracle SQL डेवलपर टूल :डाउनलोड और इंस्टालेशन

  3. ऑरैकल में चेक बाधा का उपयोग कैसे करें

  4. त्रुटि:ORA-65096:oracle में अमान्य सामान्य उपयोगकर्ता या भूमिका का नाम

  5. केस बनाम डिकोड