-
Notifications
You must be signed in to change notification settings - Fork 5
/
syrs.txt
205 lines (149 loc) · 6.43 KB
/
syrs.txt
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
*******************************************************************************
System Requirements Specification
*******************************************************************************
Introduction
===============================================================================
Document Purpose
-------------------------------------------------------------------------------
This System Requirements Specification document...
This document's purpose is twofold: on the one hand, to provide clear
requirements for development of this extension, and on the other hand, to
demonstrate how this extension allows requirements to be captured within
Sphinx-based documentation.
Document Scope
-------------------------------------------------------------------------------
This document describes the |sphinxcontrib-traceables| extension. It is limited
to system-level aspects.
Document Structure
-------------------------------------------------------------------------------
The following chapters describe...
Stakeholder Requirements
===============================================================================
The |StRS| defined the following stakeholder requirements:
.. traceable-list::
:filter: category == "StakeholderReq"
System Requirements
===============================================================================
Functional Requirements
-------------------------------------------------------------------------------
.. traceable:: REQ-TRACEDIRECTIVE
:title: Traceables can be defined using reST directive
:category: SysReq
:parents: STRQ-DEFINETRCBLS
:requirement_type: functional
:verification_method: ci-test
It must be possible to define a traceable using a reST directive.
Directive options define the traceable's attributes. Certain option keys
have special meaning:
- ``:title:`` sets the traceable's title attribute
- Options with the name of a valid relationship define the traceable's
relationships with other traceables
Directive content defines arbitrary information that is associated with
the traceable. It is shown in line where the traceable is displayed
in full, but otherwise not used in traceable processing, filtering, etc.
The content is parsed as reST code.
.. traceable-graph::
:tags: REQ-TRACEDIRECTIVE
:relationships: parents, children
.. ----------------------------------------------------------------------------
.. traceable:: REQ-TRACELISTS
:title: Lists can be generated showing traceables and their attributes
:category: SysReq
:parents: STRQ-SHOWTRACES
:requirement_type: functional
:verification_method: ci-test
It must be possible to generate lists of traceables using a reST
directive. The directive's options allow filtering and formatting of
the output.
.. traceable-graph::
:tags: REQ-TRACELISTS
:relationships: parents, children
.. ----------------------------------------------------------------------------
.. traceable:: REQ-TRACEMATRICES
:title: Matrices can be generated showing relationships between traceables
:category: SysReq
:parents: STRQ-SHOWTRACES
:requirement_type: functional
:verification_method: ci-test
:format: table
It must be possible to generate matrices of traceables using a reST
directive. The directive's options allow filtering and formatting of
the output.
.. traceable-graph::
:tags: REQ-TRACEMATRICES
:relationships: parents, children
.. ----------------------------------------------------------------------------
.. traceable:: REQ-TRACEGRAPHS
:title: Graphs can be generated showing relationships between traceables
:category: SysReq
:parents: STRQ-SHOWTRACES, STRQ-SPECGRAPHS
:requirement_type: functional
:verification_method: ci-test
.. traceable-graph::
:tags: REQ-TRACEGRAPHS
:relationships: parents, children
.. ----------------------------------------------------------------------------
.. traceable:: REQ-
:title:
:category: SysReq
:requirement_type: functional
:parents: STRQ-
:verification_method: ci-test
.. traceable-graph::
:tags: REQ-
:relationships: parents, children
Usability requirements
-------------------------------------------------------------------------------
.. traceable:: REQ-ERRORMESSAGES
:title: Helpful error messages are generated upon incorrect usage
of this extension
:category: SysReq
:requirement_type: usability
:parents: STRQ-CLEARERRMSG
:verification_method: ci-test
.. traceable-graph::
:tags: REQ-ERRORMESSAGES
:relationships: parents, children
Documentation Requirements
-------------------------------------------------------------------------------
.. traceable:: REQ-INSTALLINSTR
:title: User docs contain installation instructions
:category: SysReq
:requirement_type: documentation
:parents: STRQ-USERDOCS
:verification_method: doc-review
.. traceable-graph::
:tags: REQ-INSTALLINSTR
:relationships: parents, children
.. ----------------------------------------------------------------------------
.. traceable:: REQ-USAGEINSTR
:title: User docs contain usage instructions
:category: SysReq
:requirement_type: documentation
:parents: STRQ-USERDOCS
:verification_method: doc-review
The user documentation must describe how to use the features provided by
this extension. It must cover at least all features as stated by the
functional requirements:
.. traceable-list::
:filter: category == "SysReq" and requirement_type == "functional"
:format: bullets
.. traceable-graph::
:tags: REQ-USAGEINSTR
:relationships: parents, children
Traceability
===============================================================================
.. traceable-matrix::
:format: table
:relationship: children
:filter-primaries: category == "StakeholderReq"
:filter-secondaries: category == "SysReq"
List of system requirements:
.. traceable-list::
:format: table
:filter: category == "SysReq"
:attributes: verification_method
.. |sphinxcontrib-traceables| replace::
`sphinxcontrib-traceables <https://github.com/t4ngo/sphinxcontrib-traceables>`__
.. |OpsCon| replace:: :abbr:`OpsCon (Operational Concept)`
.. |StRS| replace:: :doc:`strs`