Skip to content

Commit 6b04fd9

Browse files
committed
finalize first req examples page.
1 parent bb4218c commit 6b04fd9

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

Examples_Reqs.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,12 @@ purpose.
6666
![](test/examples/WeatherStation/pics/exampleAllReqs.png)
6767

6868
### E#1.2: All requirements, brief subset of attributes, showing the trace
69+
In this example, all requirements are layed out on the diagram with a brief description. Furthermore,
70+
the trace between the requirements is exposed. All with just one `pumla` macro call.
6971

72+
[./test/examples/WeatherStation/exampleAllReqsBrief.puml](test/examples/WeatherStation/exampleAllReqsBrief.puml)
73+
74+
![](test/examples/WeatherStation/pics/exampleAllReqsBrief.png)
7075
### E#1.3: Overview of all requirements (Cheat Sheet)
7176
See here, how with one `pumla` macro `PUMLAPutAllReqsTable()` and overview table is put onto
7277
the diagram, counting the requirements and showing in which files they are implemented.
@@ -76,5 +81,19 @@ the diagram, counting the requirements and showing in which files they are imple
7681
![](test/examples/WeatherStation/pics/exampleReqCheatSheet.png)
7782

7883
## E#2: Put single requirements onto a diagram
84+
Here is an example where two requirements are put onto a diagram, one with a reduced subset of
85+
attributes.
86+
87+
[./test/examples/WeatherStation/exampleSingleReqs.puml](test/examples/WeatherStation/exampleSingleReqs.puml)
88+
89+
![](test/examples/WeatherStation/pics/exampleSingleReqs.png)
90+
91+
## E#3: Show the requirements trace
92+
This example shows how for a given requirement the requirements trace is created as a diagram with just one
93+
`pumla` macro call. You can
94+
argue that the example might be bad for a requirements breakdown, but it is here to show the principle
95+
and possibilities of pumla, not to show examples of perfect requirements engineering.
96+
97+
[./test/examples/WeatherStation/exampleReqTrace.puml](test/examples/WeatherStation/exampleReqTrace.puml)
7998

80-
## E#3: Show the requirements trace
99+
![](test/examples/WeatherStation/pics/exampleReqTrace.png)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
@startuml
2+
!include reqsrepo_json.puml
3+
!include pumla_macros.puml
4+
5+
left to right direction
6+
'top to bottom direction
7+
8+
' put all requirement onto a diagram
9+
' with brief subset of attributes
10+
' exposing the trace.
11+
PUMLAPutAllReqsBrief()
12+
13+
@enduml
98.7 KB
Loading

0 commit comments

Comments
 (0)