summaryrefslogtreecommitdiff
path: root/blog/2019/09/22/subplot_and_requirement_tracking.mdwn
blob: 312d9d0c41c2f9b2fe24319104a0c6bbd8be5e2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
[[!meta title="Subplot and requirement tracking"]]
[[!tag planning]]

This is an idea, and not planned to be implemented any time soon. It's
saved here to inform futur discussions.

# Tracking requiremens in Subplot

First, assign each requirement a unique mnemonic id. In this example,
it is the word in the definition list below. The "Req" suffix is just
a convention.

**SecureReq**
: System must be sequre.

**FastReq**
: The system must be fast.

# First scenario tests SequreReq only {#first .SequreReq}

Second, mark each scenario with the requirements it tests. First
scenario test the SequreReq requirement.

~~~{.subplot .SequreReq}
given a system
when it is attacked
then it is unharmed
~~~

# Second scenario also tests FastReq {#second .SequreReq .FastReq}

~~~{.subplot .SequreReq .FastReq}
given a system
when it is DDoSsed
then it is unharmed
and it still serves all legitimate users
~~~

# Output

Subplot will then annotate the output so that each requirement has
links to the scenarios that test them, something like this: 

**SecureReq** ([first](#first), [second](#second))
: System must be sequre.

**FastReq** ([second](#second))
: The system must be fast.