Qualification Completeness¶
Features¶
Overall Features: 108
Metric |
Measurement |
Target |
|---|---|---|
Safety Features without Errors |
20 |
0 |
Features without Safety Impact value |
7 |
0 |
Features without use case |
103 |
- |
Features without Errors
ID |
Title |
Tools |
|---|---|---|
CSV Table Directive |
||
Figure Directive |
||
Image Directive |
||
Include Directive |
||
List Table Directive |
||
Literal Include Directive |
||
Table Directive with Title |
||
Table of Contents Tree Directive (toctree) |
||
Named Hyperlink Reference |
||
Definable need types |
||
Bidirectional link tracking |
||
In-content need parts for granular references |
||
Tagging support |
||
Directory HTML Output |
||
ePub 3 Output |
||
HTML Output |
||
LaTeX Output |
||
Single-File HTML Output |
||
Grid Tables |
||
Simple Tables |
Features without Safety Impact value
ID |
Title |
Tools |
|---|---|---|
Built-in HTML Search |
||
Static File Support |
||
HTML Theming Support |
||
Gettext Message Catalog Output |
||
JSON Output |
||
Man Page Output |
||
Plain Text Output |
Features without use case
ID |
Title |
Si |
Tools |
|---|---|---|---|
Generate object representation in Sphinx-Needs |
yes |
||
Apply dynamic functions for meta-data computation |
yes |
||
Export needs.json file using Sphinx-Needs |
yes |
||
Enhance Need content using templates in Sphinx-Needs |
yes |
||
Extend page content with templates in Sphinx-Needs |
yes |
||
Attention Admonition |
no |
||
Caution Admonition |
no |
||
Danger Admonition |
no |
||
Error Admonition |
no |
||
Generic Admonition |
no |
||
Hint Admonition |
no |
||
Important Admonition |
no |
||
Note Admonition |
no |
||
Tip Admonition |
no |
||
Warning Admonition |
no |
||
Built-in HTML Search |
|||
Static File Support |
|||
HTML Theming Support |
|||
Block Quotes |
no |
||
Line Blocks |
no |
||
Code Block Directive |
no |
||
Contents Directive (Local ToC) |
no |
||
CSV Table Directive |
yes |
||
Figure Directive |
yes |
||
Image Directive |
yes |
||
Include Directive |
yes |
||
List Table Directive |
yes |
||
Literal Include Directive |
yes |
||
Math Directive |
no |
||
Raw Content Directive |
no |
||
Rubric Directive |
no |
||
Table Directive with Title |
yes |
||
Table of Contents Tree Directive (toctree) |
yes |
||
Italicized (Emphasis) Text |
no |
||
Escaped Markup Characters |
no |
||
Inline Internal Target |
no |
||
Inline Literal (Code) Text |
no |
||
Named Hyperlink Reference |
yes |
||
Bold (Strong) Text |
no |
||
Citations |
no |
||
Explicit Target Creation |
no |
||
External Hyperlinks |
no |
||
Footnotes |
no |
||
Implicit Hyperlinks from URLs |
no |
||
Internal Cross-References to Labels |
no |
||
Auto-Numbered Lists |
no |
||
Bulleted Lists |
no |
||
Definition Lists |
no |
||
Numbered (Enumerated) Lists |
no |
||
Nested Lists |
no |
||
Option Lists |
no |
||
Automatic ID generation |
yes |
||
Configuration via conf.py or an external TOML file |
no |
||
Customizable layouts for need presentation |
yes |
||
Customizable link types |
yes |
||
Customizable need options |
yes |
||
Definable need types |
yes |
||
Create a bar chart based on need statistics (needbar) |
no |
||
Modify existing needs in bulk (needextend) |
yes |
||
Render a PlantUML flow diagram of needs (needflow) |
no |
||
Import needs from an external JSON file (needimport) |
yes |
||
Create a pie chart based on need statistics (needpie) |
no |
||
Display needs in a filterable table (needtable) |
no |
||
Constraint checking to validate need relationships |
yes |
||
JSON builder to export all need data |
yes |
||
Permalink generation to specific need objects |
yes |
||
Bidirectional link tracking |
yes |
||
Dead link detection and warnings |
yes |
||
Direct linking between needs using IDs |
yes |
||
Manual ID assignment |
yes |
||
In-content need parts for granular references |
yes |
||
Need status enforcement |
yes |
||
Tagging support |
yes |
||
Unique ID enforcement and checks |
yes |
||
Directory HTML Output |
yes |
||
ePub 3 Output |
yes |
||
Gettext Message Catalog Output |
|||
HTML Output |
yes |
||
JSON Output |
|||
LaTeX Output |
yes |
||
Man Page Output |
|||
Single-File HTML Output |
yes |
||
Plain Text Output |
|||
Code Role |
no |
||
Document Role |
no |
||
Emphasis Role |
no |
||
Literal Role |
no |
||
Inline Math Role |
no |
||
Numbered Reference Role |
no |
||
Reference Role |
no |
||
Strong Role |
no |
||
Subscript Role |
no |
||
Superscript Role |
no |
||
Document Title and Subtitle |
no |
||
Section Titles with Underlines |
no |
||
Transitions (Horizontal Lines) |
no |
||
Grid Tables |
yes |
||
Simple Tables |
yes |
||
Build needs.json |
yes |
||
Clean internal caches |
no |
||
Format rst files |
yes |
||
Check rst files for linting problems |
no |
||
Validate needs.json |
no |
Errors¶
Overall Errors: 82
Metric |
Measurement |
Target |
|---|---|---|
Errors without Mitigation |
75 |
0 |
Errors without Mitigation
ID |
Title |
Parent Needs |
|---|---|---|
Programmatic errors in rst/md files result in ignored Traceability objects |
||
Constraint check fails silently |
||
Constraint check runs with incomplete data |
||
Constraint check runs with invalid data |
||
Constraint not checked during build |
||
Constraint check runs with wrong data |
||
Content contains syntax errors |
||
Dead link false positive |
||
Dead link not detected |
||
Duplicate ID is not detected |
||
Function returns invalid value |
||
Function gets not executed |
||
Function returns no value |
||
Function returns wrong calculated values |
||
Exported needs.json file is corrupted |
||
Exporting needs.json fails silently |
||
Exported needs.json file is not valid |
||
Bulk modification failes silently |
||
Bulk modification of needs is not completed |
||
Bulk modification of needs is not valid |
||
ID already exists |
||
ID format is invalid |
||
ID generation failed |
||
ID length is invalid |
||
Importing needs is not accessible |
||
Importing needs is not completed |
||
Importing needs is not valid |
||
Invalid link type used in a need |
||
Link type value is not valid |
||
Invalid option used in a need |
||
Option value is not valid |
||
Invalid status used in a need |
||
Traceability objects content corrupted |
||
Traceability objects meta-data corrupted |
||
Corrupted external needs.json file |
||
Invalid or incorrect filters used for external needs.json |
||
Traceability objects links corrupted |
||
Objects missing in needs.json |
||
Missing external needs.json file |
||
Meta-data missing |
||
Wrong meta-data is used |
||
Layout leads to incorrect information |
||
Layout leads to incorrect rendering |
||
Layout leads to missing information |
||
Link target not found |
||
Link target is not valid |
||
External needs corrupted |
||
Links missing |
||
Back-links are not set |
||
External needs not found |
||
Internal target link is not found |
||
Manual ID already exists |
||
Manual ID format is invalid |
||
Manual ID length is invalid |
||
Sphinx-Needs data not valid |
||
Sphinx-Needs data is not process-compliant |
||
Option value is not allowed |
||
Permalink generation fails silently |
||
Permalink links to non-existing need |
||
Permalink is not valid |
||
Permalink links to wrong need |
||
Authentication issues with needsservice |
||
External service unreachable by needsservice |
||
needsservice unable to process data from external service |
||
Syntax errors in rst/md files cause Traceability objects to be ignored |
||
Template file is not a valid Jinja2 template |
||
Template file not found |
||
Template file contains syntax errors |
||
Template file is not a valid Jinja2 template |
||
Template file not found |
||
Template file contains syntax errors |
||
Format introduces errors |
||
Not covered format |
||
Unknown file format |
||
Incomplete Validation |
Restrictions¶
Overall Restrictions: 8
Metric |
Measurement |
Target |
|---|---|---|
Restrictions without Error |
2 |
0 |
Restrictions without Error
ID |
Title |
Docname |
|---|---|---|
Clean full build |
tools/sphinx-needs/restrictions |
|
Clean full build |
tools/sphinx/restrictions |