Markdown for requirements management

Markdown_Requirements_Proposals.md

Requirement proposal 1

UID: REQ-002
Status: Active
Relations:

• File, file.py, hello_world
• File, file.rs, <file::FooTuple as file::FooTrait>::bar

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 2

UID: REQ-002
Status: Active
Relations:

• File:
  • Path: file.py
  • Function: hello_world
• File:
  • Path: file.rs
  • Function: <file::FooTuple as file::FooTrait>::bar

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 3

UID: REQ-002
Status: Active
Relations:

• Parent:
  • Value: REQ-1
    Role: Refines
• File:
  • Path: file.py
    Function: hello_world
  • Path: file.rs
    Function: <file::FooTuple as file::FooTrait>::bar

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 4a

UID: REQ-002
Type: Requirement
Status: Active
Relations:

• Type: Parent
  Value: REQ-1
  Role: Refines
• Type: File
  Path: file.py
  Element: Function
  ID: hello_world
  Hash: 5c2e9a1b7d4f8c3a6e0b2d1f9a7c5e3b8d6f1a4c2e9b7d0f3a5c8e1b6d2f4a9
• Type: File
  Path: file.rs
  Element: Function
  ID: <file::FooTuple as file::FooTrait>::bar
  Hash: d1f7c3a9b5e2d8f4a6c0b1e3f9a7d2c5b8e4f6a1c3d9e7b0a2f5c8d1e4b6a9f

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 4b

UID: REQ-002
Type: Requirement
Status: Active
Relations:

• Type: Parent
  Value: REQ-1
  Role: Refines
• Type: File
  Path: file.py
  Function: hello_world
• Type: File
  Path: file.rs
  Function: <file::FooTuple as file::FooTrait>::bar

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 5

UID: REQ-002
Status: Active
Relations:

• Parent | REQ-1 | Refines
• File | file.py | hello_world
• File | file.rs | <file::FooTuple as file::FooTrait>::bar

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 6

UID: REQ-002
Type: Requirement
Status: Active
Relations:

• Parent: REQ-1
  • Role: Refines
• Child: REQ-3
• Snippet: Function hello_world in file.py
• Snippet: Macro hello_world in file.c
• Snippet: <file::FooTuple as file::FooTrait>::bar in file.rs
  • Role: Implementation

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Long functions readability check

Requirement proposal 6

UID: REQ-002
Type: Requirement
Status: Active
Relations:

• Parent: REQ-1
  • Role: Refines
• Child: REQ-3
• Snippet: Function <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar in src/foo/bar/baz/abc/xyz/123/file.rs
  • Role: Implementation
• Snippet: Function <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar in src/foo/bar/baz/abc/xyz/123/file.rs
  • Role: Implementation
• Snippet: Function <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar in src/foo/bar/baz/abc/xyz/123/file.rs
  • Role: Implementation

Statement: The system shall show "Hello".

Rationale: This is a simple example.

Requirement proposal 4a

UID: REQ-002
Type: Requirement
Status: Active
Relations:

• Type: Parent
  Value: REQ-1
  Role: Refines
• Type: Snippet
  File: src/foo/bar/baz/abc/xyz/123/file.rs
  Function: <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar
• Type: Snippet
  File: src/foo/bar/baz/abc/xyz/123/file.rs
  Function: <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar
• Type: Snippet
  File: src/foo/bar/baz/abc/xyz/123/file.rs
  Function: <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar
• Type: Snippet
  File: src/foo/bar/baz/abc/xyz/123/file.rs
  Function: <file::FooVeryVeryVeryVeryLongTuple as file::FooVeryVeryVeryVeryLongTrait>::bar

Statement: The system shall show "Hello".

Rationale: This is a simple example.