From 94ad86dd3d2c93261b578b48012a66f899c416c8 Mon Sep 17 00:00:00 2001 From: Viachaslau Lyskouski Date: Sun, 12 Nov 2023 18:50:36 +0100 Subject: [PATCH] [#376] [DC] Implementation Flow. Add arch. template --- docs/architectural-flow/README.md | 12 ++++ .../decisions/000000_template.md | 64 +++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 docs/architectural-flow/README.md create mode 100644 docs/architectural-flow/decisions/000000_template.md diff --git a/docs/architectural-flow/README.md b/docs/architectural-flow/README.md new file mode 100644 index 0000000000..cd7bddedf0 --- /dev/null +++ b/docs/architectural-flow/README.md @@ -0,0 +1,12 @@ +# Fingrom Application Architecture + +[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/) + +## Architectural Decision Records + +An architectural decision record (ADR) serves as a comprehensive document that outlines the significant choices made by +a team concerning the software architecture they intend to construct. Each ADR elucidates the specific architectural +decision, its contextual factors, and the anticipated consequences. These records are not static but rather dynamic, +mirroring a lifecycle that charts the evolution and impact of these decisions over time. They serve as a valuable +reference, capturing the rationale behind critical architectural choices and their effects on the overall system, +promoting transparency and understanding within the team. diff --git a/docs/architectural-flow/decisions/000000_template.md b/docs/architectural-flow/decisions/000000_template.md new file mode 100644 index 0000000000..afbf5e9c40 --- /dev/null +++ b/docs/architectural-flow/decisions/000000_template.md @@ -0,0 +1,64 @@ + + +# Description of proposal +**Status:** Proposed | Accepted | Rejected +**Date:** YYYY-MM-DD +**Author:** Author Name + +## Context and Problem Statement + +{Describe the context and problem statement, using two to three sentences} + +## Decision Drivers + +* {decision driver 1, e.g., a force, facing concern, …} +* … + +## Considered Options + +* {title of option 1} +* … + +## Decision Outcome + +In the context of , facing we decided for