Skip to content

Commit

Permalink
Merge pull request #18 from amosproj/bugfix/licensing-fix
Browse files Browse the repository at this point in the history
Fixing the licensing issues created by PRs
  • Loading branch information
felix-zailskas authored Oct 25, 2023
2 parents 115c350 + 0b14c48 commit c8141b9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
16 changes: 13 additions & 3 deletions Documentation/Architecture.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,49 @@
<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: 2023 Simon Zimmermann
-->

# 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)
3 changes: 3 additions & 0 deletions Documentation/Media/component-diagram.svg.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: 2023 Simon Zimmermann
SPDX-FileCopyrightText: 2023 Lucca Baumgärtner
2 changes: 2 additions & 0 deletions Documentation/Media/sequence-diagram.svg.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: 2023 Lucca Baumgärtner

0 comments on commit c8141b9

Please sign in to comment.