Skip to content

Conversation

@vascosousamindera
Copy link
Collaborator

Ticket: ALFMOB-178

This PR introduces documentation related to the project in order to improve architectural clarity, system understanding, and onboarding efficiency.


The following documentation has been added:

C4 Diagrams aligned with 4+1 Model

  • Logical Views:

    • Level 1 – System Context Diagram
    • Level 2 – Container Diagram
    • Level 3 – Component Diagram (MelmacBE & DriverRunner)
  • Physical View:

    • Level 2 Deployment Diagram showing execution context on local machines and device environments.
  • Implementation Views:

    • Level 2 – High-level implementation structure (e.g., backend modules and runners)
    • Level 3 – Clean Architecture breakdown (Infrastructure, Adapters, Use Cases, Domain)

FURPS+ and Database Specification

  • Updated FURPS+ quality model, covering:

    • Functionality, Usability, Reliability, Performance, and Supportability
  • Added Database Specification:

    • Key tables, constraints, and relationships supporting bootstrap data, test executions, metrics, and thresholds.

This documentation aims to fill existing gaps and establish a clear, extensible architectural foundation for development, testing, and future onboarding.

- Added logical views of level 1,2 and 3
- Added physical view of level 2
- Added implementation views of level 2 and 3
- Updated FURPS+
- Added Database specification
- Added Use Case Diagram
- Updated readmes
@vascosousamindera vascosousamindera self-assigned this Jun 3, 2025
@vascosousamindera vascosousamindera added the documentation Improvements or additions to documentation label Jun 3, 2025
@github-actions github-actions bot merged commit 4cb0ba9 into main Jun 3, 2025
3 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Jun 3, 2025

📝 Performance Test Results

Performance Test Suite Results (Android)

Suite Execution: 14
Test Suite Version: 16

Test Execution Results

Test Execution: Startup Time Plan

  • Metric: App Startup Time
  • Device: Medium_Phone_API_35
  • App Name: Alfie.apk
  • App Version: 0.8.0
  • App Package: au.com.alfie.ecomm.debug
  • Main Activity: au.com.alfie.ecomm.MainActivity
  • Execution Type: Cold Start
Test Result Start Time End Time
true 2025-06-03T22:20:26.654 2025-06-03T22:21:33.602
Thresholds
Target Value Threshold Type Metric Output
20000 Max launchTime
Metric Output Results
Metric Output Value
launchTime 14927
elementFound true

@github-actions
Copy link
Contributor

github-actions bot commented Jun 3, 2025

📝 Performance Test Results

Performance Test Suite Results (iOS)

Suite Execution: 16
Test Suite Version: 15

Test Execution Results

Test Execution: Startup Time Plan

  • Metric: App Startup Time
  • Device: iPhone 16 Pro
  • App Name: Alfie.app
  • App Version: 0.8.1
  • App Package: com.mindera.alfie.debug
  • Main Activity: N/A
  • Execution Type: Cold Start
Test Result Start Time End Time
false 2025-06-03T22:19:53.699 2025-06-03T22:23:38.589
Thresholds
Target Value Threshold Type Metric Output
5000 Max launchTime
Metric Output Results
Metric Output Value
launchTime 6417
elementFound true

@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
@Mindera Mindera deleted a comment from github-actions bot Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants