Skip to content

Commit ecda618

Browse files
vascosousaminderavascosousamindera
committed
Updates to documentation to be according to latest changes
1 parent 540f5e4 commit ecda618

File tree

32 files changed

+5543
-5536
lines changed

32 files changed

+5543
-5536
lines changed

‎docs/assets/database.svg‎

Lines changed: 2776 additions & 2776 deletions
Loading

‎docs/global-artifacts/01.requirements-engineering/puml/use-case-diagram.puml‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
@startuml use-case-diagram
2-
left to right direction
3-
4-
actor "Developer" as Dev
5-
6-
rectangle "Melmac Performance Testing Framework" {
7-
usecase "UC1: As a Developer, I want to create a Test Suite" as UC1
8-
usecase "UC2: As a Developer, I want to create a Test Plan" as UC2
9-
usecase "UC3: As a Developer, I want to run a Test Suite" as UC3
10-
usecase "UC4: As a Developer, I want to run a Test Plan" as UC4
11-
}
12-
13-
Dev --> UC1
14-
Dev --> UC2
15-
Dev --> UC3
16-
Dev --> UC4
17-
18-
@enduml
1+
@startuml use-case-diagram
2+
left to right direction
3+
4+
actor "Developer" as Dev
5+
6+
rectangle "Melmac Performance Testing Framework" {
7+
usecase "Create a Test Suite" as UC1
8+
usecase "Create a Test Plan" as UC2
9+
usecase "Run a Test Suite" as UC3
10+
usecase "Run a Test Plan" as UC4
11+
}
12+
13+
Dev --> UC1
14+
Dev --> UC2
15+
Dev --> UC3
16+
Dev --> UC4
17+
18+
@enduml

‎docs/global-artifacts/01.requirements-engineering/use-cases.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Use Case Diagram and Use Cases
2-
3-
## Use Case Diagram
4-
5-
The use case diagram provides a high-level overview of the system's functionality by illustrating the interactions between users (actors) and the system's use cases. It helps identify the main actors and their goals when using the system.
6-
7-
![Use Case Diagram](./svg/use-case-diagram.svg)
8-
9-
## Use Cases
10-
11-
This section outlines the specific use cases for the system, detailing the interactions between actors and the system. Each use case includes a description, preconditions, and postconditions to clarify the expected behavior of the system.
12-
13-
| Use Case | Description |
14-
| -------------------------- | ---------------------------------------------------------------------------- |
15-
| **UC1: As a Developer, I want to create a Test Suite** | The user creates a new test suite to organize related test scripts. |
16-
| **UC2: As a Developer, I want to create a Test Plan** | The user defines a test script, specifying objectives, scope, and resources. |
17-
| **UC3: As a Developer, I want to run a Test Suite** | The user executes all test scripts within a selected test suite. |
18-
| **UC4: As a Developer, I want to run a Test Plan** | The user initiates the execution of a specific test script. |
19-
20-
---
1+
# Use Case Diagram and Use Cases
2+
3+
## Use Case Diagram
4+
5+
The use case diagram provides a high-level overview of the system's functionality by illustrating the interactions between users (actors) and the system's use cases. It helps identify the main actors and their goals when using the system.
6+
7+
![Use Case Diagram](./svg/use-case-diagram.svg)
8+
9+
## Use Cases
10+
11+
This section outlines the specific use cases for the system, detailing the interactions between actors and the system. Each use case includes a description, preconditions, and postconditions to clarify the expected behavior of the system.
12+
13+
| Use Case | Description |
14+
| -------------------------- | ---------------------------------------------------------------------------- |
15+
| **UC1: As a Developer, I want to create a Test Suite** | The user creates a new test suite to organize related test scripts. |
16+
| **UC2: As a Developer, I want to create a Test Plan** | The user defines a test script, specifying objectives, scope, and resources. |
17+
| **UC3: As a Developer, I want to run a Test Suite** | The user executes all test scripts within a selected test suite. |
18+
| **UC4: As a Developer, I want to run a Test Plan** | The user initiates the execution of a specific test script. |
19+
20+
---

‎docs/global-artifacts/03.design/implementation-view/level-2/drawio/L2-IV.drawio‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
<mxfile host="65bd71144e">
2-
<diagram name="Página-1" id="H5xfOcXILhlzlC3MEp8S">
3-
<mxGraphModel dx="863" dy="867" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
4-
<root>
5-
<mxCell id="0"/>
6-
<mxCell id="1" parent="0"/>
7-
<mxCell id="23" value="" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
8-
<mxGeometry x="140" y="80" width="620" height="350" as="geometry"/>
9-
</mxCell>
10-
<mxCell id="KfgiDUAFI2g06yitJ3mN-1" value="Melmac Performance Testing Framework" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;align=center;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
11-
<mxGeometry x="190" y="130" width="520" height="250" as="geometry"/>
12-
</mxCell>
13-
<mxCell id="7" style="edgeStyle=none;html=1;entryX=0;entryY=0;entryDx=0;entryDy=77;entryPerimeter=0;exitX=0;exitY=0;exitDx=150;exitDy=77;exitPerimeter=0;strokeColor=default;dashed=1;dashPattern=12 12;" parent="1" source="3" target="5" edge="1">
14-
<mxGeometry relative="1" as="geometry">
15-
<Array as="points"/>
16-
</mxGeometry>
17-
</mxCell>
18-
<mxCell id="3" value="MelmacBE" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
19-
<mxGeometry x="230" y="200" width="150" height="140" as="geometry"/>
20-
</mxCell>
21-
<mxCell id="5" value="DriverRunner (iOS)" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
22-
<mxGeometry x="480" y="200" width="144" height="140" as="geometry"/>
23-
</mxCell>
24-
<mxCell id="18" value="Untitled Layer" parent="0"/>
25-
<mxCell id="11" value="Untitled Layer" parent="0"/>
26-
</root>
27-
</mxGraphModel>
28-
</diagram>
1+
<mxfile host="65bd71144e">
2+
<diagram name="Página-1" id="H5xfOcXILhlzlC3MEp8S">
3+
<mxGraphModel dx="863" dy="867" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
4+
<root>
5+
<mxCell id="0"/>
6+
<mxCell id="1" parent="0"/>
7+
<mxCell id="23" value="" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
8+
<mxGeometry x="140" y="80" width="620" height="350" as="geometry"/>
9+
</mxCell>
10+
<mxCell id="KfgiDUAFI2g06yitJ3mN-1" value="Melmac Performance Testing Framework" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;align=center;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
11+
<mxGeometry x="190" y="130" width="520" height="250" as="geometry"/>
12+
</mxCell>
13+
<mxCell id="7" style="edgeStyle=none;html=1;entryX=0;entryY=0;entryDx=0;entryDy=77;entryPerimeter=0;exitX=0;exitY=0;exitDx=150;exitDy=77;exitPerimeter=0;strokeColor=default;dashed=1;dashPattern=12 12;" parent="1" source="3" target="5" edge="1">
14+
<mxGeometry relative="1" as="geometry">
15+
<Array as="points"/>
16+
</mxGeometry>
17+
</mxCell>
18+
<mxCell id="3" value="MelmacBE" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
19+
<mxGeometry x="230" y="200" width="150" height="140" as="geometry"/>
20+
</mxCell>
21+
<mxCell id="5" value="DriverRunner (iOS)" style="shape=folder;fontStyle=1;spacingTop=10;tabWidth=40;tabHeight=14;tabPosition=left;html=1;whiteSpace=wrap;verticalAlign=top;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
22+
<mxGeometry x="480" y="200" width="144" height="140" as="geometry"/>
23+
</mxCell>
24+
<mxCell id="18" value="Untitled Layer" parent="0"/>
25+
<mxCell id="11" value="Untitled Layer" parent="0"/>
26+
</root>
27+
</mxGraphModel>
28+
</diagram>
2929
</mxfile>

0 commit comments

Comments
 (0)