आर्किटेक्चर निर्णय रिकॉर्ड (ADR) टेम्पलेट

यह EdgeX Foundry ADR का टेम्पलेट है।

स्रोत: https://docs.edgexfoundry.org/2.3/design/adr/template/

प्रस्तुतकर्ता

ADR के प्रस्तुतकर्ताओं की सूची दें।

प्रारूप:

• नाम (संगठन)

परिवर्तन लॉग

दस्तावेज़ में हुए परिवर्तनों की सूची दें, जिसमें अवस्था, तिथि और PR URL शामिल हों।

अवस्था इनमें से एक है: pending (लंबित), approved (अनुमोदित), amended (संशोधित), deprecated (अप्रचलित)।

तिथि ISO 8601 (YYYY-MM-DD) स्ट्रिंग है।

PR वह पुल रिक्वेस्ट है जिसने परिवर्तन प्रस्तुत किया, जिसमें अंतर, योगदानकर्ता और समीक्षक जैसी जानकारी होती है।

प्रारूप:

• [ADR की अवस्था जैसे approved, amended आदि](पुल रिक्वेस्ट का URL) YYYY-MM-DD

संदर्भित उपयोग-मामले

सभी प्रासंगिक उपयोग-मामले / आवश्यकता दस्तावेज़ों की सूची दें।

ADR के लिए कम से कम एक प्रासंगिक, अनुमोदित उपयोग-मामला आवश्यक है।

प्रारूप:

• [उपयोग-मामले का नाम](URL)

यदि ADR किसी उपयोग-मामले की सभी आवश्यकताओं को संबोधित नहीं करता है, तो स्पष्टीकरण जोड़ें।

संदर्भ

वर्णन करें:

• डिज़ाइन आर्किटेक्चर की दृष्टि से कैसे महत्वपूर्ण है, जिससे ADR उचित ठहरता है (किसी समस्या को ठीक करने के लिए साधारण issue और PR के बजाय)

• उच्च-स्तरीय डिज़ाइन दृष्टिकोण (विवरण नीचे प्रस्तावित डिज़ाइन में वर्णित है)

प्रस्तावित डिज़ाइन

डिज़ाइन का विवरण (जहाँ संभव हो, क्रियान्वयन में गए बिना)।

रूपरेखा:

• प्रभावित (परिवर्तित) होने वाली सेवाएँ/मॉड्यूल

• जोड़ी जाने वाली नई सेवाएँ/मॉड्यूल

• मॉडल और DTO पर प्रभाव (परिवर्तन/जोड़/हटाव)

• API पर प्रभाव (परिवर्तन/जोड़/हटाव)

• सामान्य कॉन्फ़िगरेशन पर प्रभाव (नए खंडों की स्थापना, परिवर्तन/जोड़/हटाव)

• devops पर प्रभाव

विचारणीय बातें

ADR पर बहस के दौरान उठे विकल्प, चिंताएँ, सहायक या संबंधित मुद्दे और प्रश्न दर्ज करें।

बताएँ कि उनका समाधान या शमन हुआ या नहीं, और कैसे।

निर्णय

किसी भी सहमत महत्वपूर्ण क्रियान्वयन विवरण, सावधानियों, भविष्य के विचारों, और शेष या स्थगित डिज़ाइन मुद्दों को दर्ज करें।

प्रस्तावित डिज़ाइन द्वारा पूरी न की गई आवश्यकताओं के किसी भी भाग को दर्ज करें।

अन्य संबंधित ADR

किसी भी प्रासंगिक ADR की सूची दें, जैसे किसी सुविधा के उप-घटक का डिज़ाइन निर्णय, इस डिज़ाइन के परिणामस्वरूप अप्रचलित हुआ कोई डिज़ाइन आदि।

प्रारूप:

• [ADR शीर्षक](URL) - प्रासंगिकता

संदर्भ सामग्री

अतिरिक्त संदर्भों की सूची दें।

प्रारूप:

• [शीर्षक](URL)