תבנית רשומת החלטה ארכיטקטונית (ADR)

זוהי תבנית ל-ADR של EdgeX Foundry.

מקור: https://docs.edgexfoundry.org/2.3/design/adr/template/

מגישים

פרטו את מגישי ה-ADR.

פורמט:

• שם (ארגון)

יומן שינויים

פרטו את השינויים במסמך, כולל מצב, תאריך וכתובת ה-PR.

המצב הוא אחד מאלה: pending, approved, amended, deprecated.

התאריך הוא מחרוזת ISO 8601 (YYYY-MM-DD).

ה-PR הוא ה-pull request שהגיש את השינוי, כולל מידע כמו ה-diff, התורמים והסוקרים.

פורמט:

• [מצב ה-ADR, למשל approved, amended וכדומה](כתובת ה-pull request) YYYY-MM-DD

מקרי שימוש שאליהם מתייחסים

פרטו את כל מסמכי מקרי השימוש / הדרישות הרלוונטיים.

ADR דורשת לפחות מקרה שימוש רלוונטי ומאושר אחד.

פורמט:

• [שם מקרה השימוש](כתובת URL)

הוסיפו הסברים אם ה-ADR אינה עונה על כל הדרישות של מקרה שימוש.

הקשר

תארו:

• באיזה אופן העיצוב משמעותי מבחינה ארכיטקטונית, באופן שמצדיק ADR (ולא issue ו-PR פשוטים לתיקון בעיה)

• את גישת העיצוב ברמה גבוהה (הפרטים מתוארים בעיצוב המוצע להלן)

עיצוב מוצע

פרטי העיצוב (בלי להיכנס למימוש במידת האפשר).

מתווה:

• שירותים/מודולים שיושפעו (ישתנו)

• שירותים/מודולים חדשים שיתווספו

• השפעה על מודלים ו-DTO (שינויים/תוספות/הסרות)

• השפעה על API (שינויים/תוספות/הסרות)

• השפעה על הגדרות כלליות (יצירת סעיפים חדשים, שינויים/תוספות/הסרות)

• השפעה על devops

שיקולים

תעדו חלופות, חששות, סוגיות נלוות או קשורות, ושאלות שעלו בדיון על ה-ADR.

ציינו אם ואיך הן נפתרו או רוככו.

החלטה

תעדו כל פרט מימוש חשוב שהוסכם עליו, הסתייגויות, שיקולים עתידיים, וסוגיות עיצוב שנותרו או נדחו.

תעדו כל חלק מהדרישות שהעיצוב המוצע אינו מספק.

ADR קשורות אחרות

פרטו כל ADR רלוונטית, כמו החלטת עיצוב לרכיב משנה של יכולת, עיצוב שהוצא משימוש כתוצאה מהעיצוב הזה וכדומה.

פורמט:

• [כותרת ה-ADR](כתובת URL) - רלוונטיות

הפניות

פרטו הפניות נוספות.

פורמט:

• [כותרת](כתובת URL)