- Introduction
- Problem Statement
- Solution
- Architectural Decisions and Background
- Software Components
- System Requirements
- Timeline
- Development Workflow
- Context Diagrams
- Release Notes
- Contributing
- References
- License
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
The problem statement explain the constraints that provided the significant influence over the architecture.
The objective key results (OKRs) of the product.
- FR1: The system shall be able to ...
- FR2: The system shall be able to ...
- The software ecosystem should be easy to use.
- The software ecosystem should be easy to maintain.
The architectural decisions and background explain the decisions that were made during the development process.
The software ecosystem of the product is composed of the following components:
This section describes the general function and purpose for the system or subsystem whose architecture is described in this SWAD.
The timeline of the project. The timeline is a list of the major milestones and the dates they are expected to be completed.
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: ...
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.
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 ...
Please refer to the CONTRIBUTING.md file for more information.
This project is licensed under the MIT License - see the LICENSE file for details