Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

drafts/requirements: more statuses and links for reqs in the SDoc-level spec #1249

Merged
merged 1 commit into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions drafts/requirements/20_high_level/20_HLR.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,24 @@ The Requirements Tool shall support the CRUD operations:

[REQUIREMENT]
UID: SDOC-SSS-61
STATUS: Active
REFS:
- TYPE: Parent
VALUE: ZEP-10
- TYPE: Parent
VALUE: ZEP-14
TITLE: Minimal requirement field set
STATEMENT: >>>
The Requirements Tool shall support at least the following requirement field set:

- UID
- STATUS
- LINKS (references to other requirements)
- TITLE
- STATEMENT
- RATIONALE
- COMMENT.
<<<

[REQUIREMENT]
UID: SDOC-SSS-62
Expand Down Expand Up @@ -61,10 +73,22 @@ TITLE: Structuring requirements in documents

[REQUIREMENT]
UID: SDOC-SSS-5
STATUS: Active
REFS:
- TYPE: Parent
VALUE: SDOC-RMC-1
TITLE: Move document nodes within document and between documents
TITLE: Move document nodes within document
STATEMENT: >>>
The Requirements Tool shall allow moving nodes (sections, requirements) within the containing document.
<<<

[REQUIREMENT]
UID: SDOC-SSS-70
STATUS: Active
TITLE: Move nodes between documents
STATEMENT: >>>
The Requirements Tool shall allow moving nodes (sections, requirements) between documents.
<<<

[REQUIREMENT]
UID: SDOC-SSS-6
Expand Down Expand Up @@ -94,7 +118,10 @@ UID: SDOC-SSS-47
REFS:
- TYPE: Parent
VALUE: SDOC-RMC-7
TITLE: Prevent cycles between nodes.
TITLE: Prevent cycles between nodes
STATEMENT: >>>
The Requirements Tool shall provide a validation mechanism that prevents requirement links from forming cycles.
<<<

[REQUIREMENT]
UID: SDOC-SSS-57
Expand Down
48 changes: 48 additions & 0 deletions drafts/requirements/30_low_level/30_SLR.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,25 @@ RATIONALE: >>>
The most commonly used Markdown format lacks the ability to store requirements metadata. While the RST syntax does allow for customization with directives to implement metadata extensions, its visual appearance contradicts other requirements of StrictDoc, such as the type-safety of the grammar and visual readability. Therefore, a markup language tailored specifically to the needs of the requirements tool provides direct control over the capabilities implemented in both the markup and the user interface.
<<<

[REQUIREMENT]
UID: SDOC-SRS-93
STATUS: Active
REFS:
- TYPE: Parent
VALUE: SDOC-SSS-61
TITLE: Default grammar fields
STATEMENT: >>>
The StrictDoc grammar shall have at least the following fields activated by default:

- UID
- STATUS
- LINKS (references to other requirements)
- TITLE
- STATEMENT
- RATIONALE
- COMMENT.
<<<

[REQUIREMENT]
UID: SDOC-SRS-21
STATUS: Active
Expand Down Expand Up @@ -419,6 +438,7 @@ UID: SECTION-SRS-Quality-requirements
TITLE: Development process requirements

[SECTION]
UID: SECTION-SRS-Requirements-engineering
TITLE: Requirements engineering

[REQUIREMENT]
Expand Down Expand Up @@ -607,6 +627,34 @@ UID: SDOC-SRS-55
STATUS: Implemented
TITLE: Edit requirement nodes

[REQUIREMENT]
UID: SDOC-SRS-92
STATUS: Active
REFS:
- TYPE: Parent
VALUE: SDOC-SSS-5
TITLE: Move requirement / section nodes within document
STATEMENT: >>>
StrictDoc's Document screen shall provide a capability to move the nodes within a document.
<<<
RATIONALE: >>>
Moving the nodes within a document is a convenience feature that speeds up the requirements editing process significantly.
<<<

[REQUIREMENT]
UID: SDOC-SRS-94
STATUS: Backlog
REFS:
- TYPE: Parent
VALUE: SDOC-SSS-70
TITLE: Move requirement / section nodes between documents
STATEMENT: >>>
StrictDoc's Document screen shall provide a capability to move the nodes between documents.
<<<
RATIONALE: >>>
Moving the nodes within a document is a convenience feature that speeds up the requirements editing process significantly.
<<<

[REQUIREMENT]
UID: SDOC-SRS-56
STATUS: Implemented
Expand Down
Loading