Architecture Decision Recordआर्किटेक्चर निर्णय नोंद (ADR) साचा
हा EdgeX Foundry ADR साठीचा साचा आहे.
स्रोत: https://docs.edgexfoundry.org/2.3/design/adr/template/
सादरकर्ते
ADR सादर करणाऱ्यांची यादी करा.
स्वरूप:
- नाव (संस्था)
बदल नोंद
दस्तऐवजातील बदलांची यादी करा, ज्यात स्थिती, तारीख आणि PR URL समाविष्ट आहे.
स्थिती यांपैकी एक असते: प्रलंबित, मंजूर, सुधारित, कालबाह्य.
तारीख ही ISO 8601 (YYYY-MM-DD) स्ट्रिंग असते.
PR म्हणजे बदल सादर करणारी pull request, ज्यात diff, योगदानकर्ते आणि पुनरावलोकनकर्ते यांसारखी माहिती समाविष्ट आहे.
स्वरूप:
- [ADR ची स्थिती उदा. मंजूर, सुधारित इत्यादी](pull request चा URL) YYYY-MM-DD
संदर्भित वापर प्रकरणे
सर्व संबंधित वापर प्रकरण / आवश्यकता दस्तऐवजांची यादी करा.
ADR साठी किमान एक संबंधित, मंजूर वापर प्रकरण आवश्यक आहे.
स्वरूप:
- [वापर प्रकरणाचे नाव](URL)
ADR एखाद्या वापर प्रकरणाच्या सर्व आवश्यकता संबोधित करत नसल्यास स्पष्टीकरणे जोडा.
संदर्भ
वर्णन करा:
डिझाइन आर्किटेक्चरदृष्ट्या कसे महत्त्वाचे आहे - ADR चे समर्थन करणारे (समस्या सोडवण्यासाठीच्या साध्या issue आणि PR च्या तुलनेत)
उच्च-स्तरीय डिझाइन दृष्टिकोन (तपशील खालील प्रस्तावित डिझाइनमध्ये वर्णन केले आहेत)
प्रस्तावित डिझाइन
डिझाइनचे तपशील (शक्य तिथे अंमलबजावणीत न शिरता).
रूपरेषा:
प्रभावित होणाऱ्या (बदलल्या जाणाऱ्या) सेवा/मॉड्यूल
जोडल्या जाणाऱ्या नवीन सेवा/मॉड्यूल
मॉडेल आणि DTO वर परिणाम (बदल/भर/वगळणे)
API वर परिणाम (बदल/भर/वगळणे)
सामान्य कॉन्फिगरेशनवर परिणाम (नवीन विभागांची स्थापना, बदल/भर/वगळणे)
devops वर परिणाम
विचार
ADR च्या चर्चेत उद्भवलेले पर्याय, चिंता, पूरक किंवा संबंधित मुद्दे आणि प्रश्न नोंदवा.
ते सोडवले किंवा सौम्य केले गेले का आणि कसे ते नमूद करा.
निर्णय
मान्य झालेला कोणताही महत्त्वाचा अंमलबजावणी तपशील, सावधानता, भविष्यातील विचार, उरलेले किंवा पुढे ढकललेले डिझाइन मुद्दे नोंदवा.
प्रस्तावित डिझाइनने पूर्ण न केलेला आवश्यकतांचा कोणताही भाग नोंदवा.
इतर संबंधित ADR
कोणत्याही संबंधित ADR ची यादी करा - जसे की वैशिष्ट्याच्या उप-घटकासाठी डिझाइन निर्णय, या डिझाइनच्या परिणामी कालबाह्य झालेले डिझाइन इत्यादी.
स्वरूप:
- [ADR शीर्षक](URL) - सुसंगतता
संदर्भ सूची
अतिरिक्त संदर्भांची यादी करा.
स्वरूप:
- [शीर्षक](URL)