SmartSMS © TakeOff

Table of Contents

• Introduction
  • Product Overview
• Problem Statement
• Solution
  • Functional Requirements
  • Non-Functional Requirements
• Architectural Decisions and Background
• Software Components
• System Requirements
• Timeline
• Development Workflow
• Context Diagrams
• Release Notes
• Contributing
• References
• License

Introduction

Product Overview

This repository contains the an overview of the product and the development process.

Here is the initial mockup of the desktop application: Desktop Application Mockup

Problem Statement

The problem statement explain the constraints that provided the significant influence over the architecture.

Solution

Product Objectives

The objective key results (OKRs) of the product.

Functional Requirements

• FR1: The system shall be able to ...
• FR2: The system shall be able to ...

Non-Functional Requirements

• The software ecosystem should be easy to use.
• The software ecosystem should be easy to maintain.

Architectural decisions and background

The architectural decisions and background explain the decisions that were made during the development process.

Software Components

The software ecosystem of the product is composed of the following components:

• Frontend components and elements (UI/UX)
• Backend (REST API)
• Anayltics (Streaming applicaiton)
• Datamart (Data Model)

System Requirements

This section describes the general function and purpose for the system or subsystem whose architecture is described in this SWAD.

Timeline

The timeline of the project. The timeline is a list of the major milestones and the dates they are expected to be completed.

Development workflow

The development workflow describes the development process of the product. The development process is composed of the following steps:

• Step 1: ...
• Step 2: ...
• Step 3: ...

Context Diagrams

This section describes the goals and major contextual factors for the software architecture.

The section includes a description of the role software architecture plays in the life cycle, the relationship to system engineering results and artifacts, and any other relevant factors.

Release Notes

The release notes describe the changes made in each release. The release notes are composed of the following sections:

• Release 1.0.0
  • FR1: The system shall be able to ...
  • FR2: The system shall be able to ...

Contributing

Please refer to the CONTRIBUTING.md file for more information.

References

• Software Design
• Software Architecture Document

License

This project is licensed under the MIT License - see the LICENSE file for details