Requirement List Directives¶
Must
A mandatorylist directive is required. It should produce a list of all MUST and MUST NOT directives (and their aliases).
Must
A recommendedlist directive is required. It should produce a list of all SHOULD and SHOULD NOT directives (and their aliases).
Must
A optionallist directive is required. It should produce a list of all OPTIONAL and MAY directives.
Example Mandatory List¶
The following list of mandatory reqirements includes every MUST, MUST NOT, SHALL, SHALL NOT and REQUIRED semantic in this suite of documentation, because they are makted up with the appropriate directives.
Must
As per RFC 2119, users of this module should include a block of boilerplate near the beginning of their sphinx document. A rfc2119interpretation directive is required for this purpose.
(The original entry is located in introduction.rst, line 24 and can be found here.)
Must
A must directive is required, with semantic equivalence to the MUST keyword in RFC 2119.
(The original entry is located in requirement_directives.rst, line 17 and can be found here.)
Must Not
The absence of a must_not directive is forbidden. This directive has semantic equivalence to the MUST NOT keyword in RFC 2119
(The original entry is located in requirement_directives.rst, line 23 and can be found here.)
Shall
A shall directive is required. It is an alias for the must directive.
(The original entry is located in requirement_directives.rst, line 30 and can be found here.)
Shall Not
The absence of a shall_not directive is forbidden. It is a necessary alias for the must_not directive.
(The original entry is located in requirement_directives.rst, line 36 and can be found here.)
Required
A required directive is something we need. It is an alias for the must directive.
(The original entry is located in requirement_directives.rst, line 42 and can be found here.)
Must
A mandatorylist directive is required. It should produce a list of all MUST and MUST NOT directives (and their aliases).
(The original entry is located in requirement_list_directives.rst, line 4 and can be found here.)
Must
A recommendedlist directive is required. It should produce a list of all SHOULD and SHOULD NOT directives (and their aliases).
(The original entry is located in requirement_list_directives.rst, line 10 and can be found here.)
Must
A optionallist directive is required. It should produce a list of all OPTIONAL and MAY directives.
(The original entry is located in requirement_list_directives.rst, line 17 and can be found here.)
Example Recommended List¶
The following list of recommendations includes every SHOULD, SHOULD NOT, RECOMMENDED etc.
Should
A should directive is important. It has semantic equivalence to the SHOULD keyword in RFC 2119.
(The original entry is located in requirement_directives.rst, line 51 and can be found here.)
Recommended
A recommended directive is very useful. It is an alias for the should directive.
(The original entry is located in requirement_directives.rst, line 57 and can be found here.)
Should Not
The absence of a should_not directive is not something we want. It is equivalent to the SHOULD NOT key word in RFC 2119.
(The original entry is located in requirement_directives.rst, line 63 and can be found here.)
Not Recommended
Because the not_recommended is an alias for should_not directive, it’s absence should be avoided.
(The original entry is located in requirement_directives.rst, line 69 and can be found here.)
Example Optional List¶
May
Optionally, this module should support governance parameters for documenting requirement status, valid from date, review date, etc.
None of these features are implemented yet, sorry. If there’s something you actually need, please raise a ticket on GitHub.
(The original entry is located in introduction.rst, line 35 and can be found here.)
Optional
It might be nice to have an optional directive, which would be equivalent of OPTIONAL keyword in RFC 2119.
(The original entry is located in requirement_directives.rst, line 78 and can be found here.)
May
As an alias for the optional directive, a may directive might also be good to have.
(The original entry is located in requirement_directives.rst, line 84 and can be found here.)