Skip to content

Commit

Permalink
Merge pull request #1233 from strictdoc-project/stanislaw/new_reqs_work
Browse files Browse the repository at this point in the history
drafts/requirements: more links and statuses, also move DO-178C to the HLR level
  • Loading branch information
stanislaw authored Jul 16, 2023
2 parents 7d5767f + 5c293ae commit 648372e
Show file tree
Hide file tree
Showing 5 changed files with 211 additions and 121 deletions.
41 changes: 39 additions & 2 deletions drafts/requirements/10_concept/10_Concept.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,14 @@ TITLE: Programming access via API (SDK)

[REQUIREMENT]
UID: SDOC-RMC-49
STATUS: Draft
TITLE: Programming access to requirements data
STATUS: Active
TITLE: Programmatic access to requirements data
STATEMENT: >>>
The Requirements Tool shall provide programmatic access to requirements data.
<<<
RATIONALE: >>>
When the requirements data is accessible by a user directly, it is possible to exchange the data or implement additional scripting procedures.
<<<

[/SECTION]

Expand Down Expand Up @@ -379,23 +385,54 @@ TITLE: Formal modeling

[REQUIREMENT]
UID: SDOC-RMC-27
STATUS: Backlog
TITLE: Integration with other systems engineering processes
STATEMENT: >>>
The Requirements Tool shall provide capabilities for integration with other systems engineering tools.
<<<

[REQUIREMENT]
UID: SDOC-RMC-29
STATUS: Backlog
TITLE: Integration with Capella
STATEMENT: >>>
The Requirements Tool shall provide integration with Capella MBSE tool.
<<<
RATIONALE: >>>
Eclipse Capella is a capable open-source tool for Model-Based Systems Engineering, https://www.eclipse.org/capella/. It should be beneficial for the requirements tool to interface with the Capella engineering community.
<<<
COMMENT: >>>
At the very least, the integration can happen through the ReqIF interface that Capella is known to support.
<<<

[REQUIREMENT]
UID: SDOC-RMC-55
STATUS: Backlog
TITLE: Support STPA method
STATEMENT: >>>
The Requirements Tool shall provide support for the STPA method.
<<<

[REQUIREMENT]
UID: SDOC-RMC-28
STATUS: Backlog
TITLE: Formalized statements
STATEMENT: >>>
The Requirements Tool shall provide capabilities for hardening requirements content with formal semantics.
<<<
COMMENT: >>>
The directions to explore:
- NASA FRET
- bmw-software-engineering/trlc
<<<

[REQUIREMENT]
UID: SDOC-RMC-30
STATUS: Backlog
TITLE: AI Assistant
STATEMENT: >>>
The Requirements Tool shall provide integration with AI tools (e.g., ChatGPT).
<<<

[/SECTION]

Expand Down
40 changes: 31 additions & 9 deletions drafts/requirements/20_high_level/20_HLR.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,10 @@ REFS:
VALUE: SDOC-RMC-3
- TYPE: Parent
VALUE: SDOC-RMC-39
- TYPE: Parent
VALUE: DO178-10
TITLE: Traceability matrices
STATEMENT: >>>
The Requirements Tool shall support generation of traceability matrices.
<<<

[REQUIREMENT]
UID: SDOC-SSS-48
Expand All @@ -215,9 +216,22 @@ REFS:
VALUE: SDOC-RMC-39
- TYPE: Parent
VALUE: SDOC-RMC-41
- TYPE: Parent
VALUE: SDOC-RMC-49
TITLE: Progress report
STATEMENT: >>>
The Requirements Tool shall allow generating a Progress Report document.

NOTE: A progress report document shall include at least the following Key Performance Indicators.

Project-level KPIs:

- Total number of requirements
- Total number of requirements without parent (excluding top-level and derived)
- Total number of TBD/TBC
- Total number of requirements without rationale
- Tags breakdown

Document-level KPIs: the same but per document.
<<<

[/SECTION]

Expand Down Expand Up @@ -250,16 +264,23 @@ UID: SDOC-SSS-31
REFS:
- TYPE: Parent
VALUE: SDOC-RMC-36
- TYPE: Parent
VALUE: DO178-6
TITLE: Web interface
STATEMENT: >>>
The Requirements Tool shall provide a web interface.
<<<

[REQUIREMENT]
UID: SDOC-SSS-32
STATUS: Active
REFS:
- TYPE: Parent
VALUE: SDOC-RMC-11
- TYPE: Parent
VALUE: SDOC-RMC-49
TITLE: Command-line interface
STATEMENT: >>>
The Requirements Tool shall provide a command line interface (CLI).
<<<

[REQUIREMENT]
UID: SDOC-SSS-33
Expand Down Expand Up @@ -300,10 +321,11 @@ following requirements apply.

[REQUIREMENT]
UID: SDOC-SSS-55
REFS:
- TYPE: Parent
VALUE: DO178-2
STATUS: Active
TITLE: Strict type-safe grammar
STATEMENT: >>>
The Requirements Tool shall provide type safety for its text language.
<<<

[REQUIREMENT]
UID: SDOC-SSS-54
Expand Down
Loading

0 comments on commit 648372e

Please sign in to comment.