Πρότυπο καταγραφής αρχιτεκτονικής απόφασης (ADR)

Αυτό είναι ένα πρότυπο για τα ADR του EdgeX Foundry.

Πηγή: https://docs.edgexfoundry.org/2.3/design/adr/template/

Υποβάλλοντες

Απαριθμήστε τους υποβάλλοντες του ADR.

Μορφή:

• Όνομα (Οργανισμός)

Αρχείο αλλαγών

Απαριθμήστε τις αλλαγές στο έγγραφο, συμπεριλαμβανομένης της κατάστασης, της ημερομηνίας και του URL του PR.

Η κατάσταση είναι μία από: pending (εκκρεμές), approved (εγκεκριμένο), amended (τροποποιημένο), deprecated (παρωχημένο).

Η ημερομηνία είναι μια συμβολοσειρά ISO 8601 (ΕΕΕΕ-ΜΜ-ΗΗ).

Το PR είναι το pull request που υπέβαλε την αλλαγή, με πληροφορίες όπως οι διαφορές, οι συνεισφέροντες και οι αναθεωρητές.

Μορφή:

• [Κατάσταση του ADR, π.χ. approved, amended κ.λπ.](URL του pull request) ΕΕΕΕ-ΜΜ-ΗΗ

Παρατιθέμενες περιπτώσεις χρήσης

Απαριθμήστε όλα τα σχετικά έγγραφα περιπτώσεων χρήσης / απαιτήσεων.

Το ADR απαιτεί τουλάχιστον μία σχετική, εγκεκριμένη περίπτωση χρήσης.

Μορφή:

• [Όνομα περίπτωσης χρήσης](URL)

Προσθέστε εξηγήσεις αν το ADR δεν καλύπτει όλες τις απαιτήσεις μιας περίπτωσης χρήσης.

Πλαίσιο

Περιγράψτε:

• πώς η σχεδίαση είναι αρχιτεκτονικά σημαντική — δικαιολογώντας ένα ADR (αντί για ένα απλό ζήτημα και PR που διορθώνει ένα πρόβλημα)

• την προσέγγιση σχεδίασης υψηλού επιπέδου (οι λεπτομέρειες περιγράφονται στην προτεινόμενη σχεδίαση παρακάτω)

Προτεινόμενη σχεδίαση

Λεπτομέρειες της σχεδίασης (χωρίς να εισέρχεστε στην υλοποίηση όπου είναι δυνατόν).

Περίγραμμα:

• υπηρεσίες/μονάδες που θα επηρεαστούν (αλλαγή)

• νέες υπηρεσίες/μονάδες προς προσθήκη

• επίπτωση σε μοντέλο και DTO (αλλαγές/προσθήκες/αφαιρέσεις)

• επίπτωση σε API (αλλαγές/προσθήκες/αφαιρέσεις)

• επίπτωση σε γενική διαμόρφωση (δημιουργία νέων ενοτήτων, αλλαγές/προσθήκες/αφαιρέσεις)

• επίπτωση σε devops

Σκέψεις

Τεκμηριώστε εναλλακτικές, ανησυχίες, δευτερεύοντα ή σχετικά ζητήματα και ερωτήματα που προέκυψαν στη συζήτηση του ADR.

Υποδείξτε αν/πώς επιλύθηκαν ή μετριάστηκαν.

Απόφαση

Τεκμηριώστε κάθε συμφωνημένη σημαντική λεπτομέρεια υλοποίησης, επιφυλάξεις, μελλοντικές σκέψεις και εναπομείναντα ή αναβληθέντα ζητήματα σχεδίασης.

Τεκμηριώστε κάθε μέρος των απαιτήσεων που δεν ικανοποιείται από την προτεινόμενη σχεδίαση.

Άλλα σχετικά ADR

Απαριθμήστε τυχόν σχετικά ADR — όπως μια απόφαση σχεδίασης για υποσυστατικό μιας λειτουργίας, μια σχεδίαση που κατέστη παρωχημένη λόγω αυτής της σχεδίασης κ.λπ.

Μορφή:

• [Τίτλος ADR](URL) - Σχετικότητα

Αναφορές

Απαριθμήστε πρόσθετες αναφορές.

Μορφή:

• [Τίτλος](URL)