From 0b14c488bf00efc5cd464a6e500880e3759c2bed Mon Sep 17 00:00:00 2001 From: Felix Zailskas Date: Wed, 25 Oct 2023 10:06:38 +0200 Subject: [PATCH] Fixing the licensing issues created by PRs Signed-off-by: Felix Zailskas --- Documentation/Architecture.md | 16 +++++++++++++--- .../Media/component-diagram.svg.license | 3 +++ Documentation/Media/sequence-diagram.svg.license | 2 ++ 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 Documentation/Media/component-diagram.svg.license create mode 100644 Documentation/Media/sequence-diagram.svg.license diff --git a/Documentation/Architecture.md b/Documentation/Architecture.md index b854aab..7d5aaca 100644 --- a/Documentation/Architecture.md +++ b/Documentation/Architecture.md @@ -1,39 +1,49 @@ + + # Software Architecture + The goal of this project is to qualify sales leads in different ways, both in terms of their likelihood of becoming customers and the size of their potential revenue. - ## External Software ### Lead Form (LF) + The _Lead Form_ is submitted by every new lead and provides a small set of data about the lead. ### Customer Relationship Management (CRM) + The project output is made available to the sales team. This can be done in different ways, e.g. writing to a Google Sheet or pushing directly to SalesForce. - ## Components ### Base Data Collector (BDC) + The _Base Data Collector_ fullfills the task of collecting data about a lead from various online sources. All collected data is then stored in a database for later retrieval in a standardized manner. ### Expected Value Predictor (EVP) + The _Expected Value Predictor_ estimates the expected value of a lead by analyzing the collected data of that lead. This is done using a machine learning approach, where the EVP is trained on historical data. Preprocessing of both the collected and the historical data should be done inside the EVP, if it goes beyond the scope of standardization. ### Controller + The _Controller_ is an optional component, which coordinates BDC, EVP and the external components as a centralized control instance. That said, another (more advanced) approach would be to use a pipelined control flow, driven by web hooks or similar signals. - ## Diagrams ### Component Diagram + ![Component Diagram](Media/component-diagram.svg) ### Sequence Diagram + ![Sequence Diagram](Media/sequence-diagram.svg) diff --git a/Documentation/Media/component-diagram.svg.license b/Documentation/Media/component-diagram.svg.license new file mode 100644 index 0000000..899fd72 --- /dev/null +++ b/Documentation/Media/component-diagram.svg.license @@ -0,0 +1,3 @@ +SPDX-License-Identifier: MIT +SPDX-FileCopyrightText: 2023 Simon Zimmermann +SPDX-FileCopyrightText: 2023 Lucca Baumgärtner diff --git a/Documentation/Media/sequence-diagram.svg.license b/Documentation/Media/sequence-diagram.svg.license new file mode 100644 index 0000000..19521aa --- /dev/null +++ b/Documentation/Media/sequence-diagram.svg.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: MIT +SPDX-FileCopyrightText: 2023 Lucca Baumgärtner