Skip to content
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
373 changes: 191 additions & 182 deletions docs/strictdoc_20_L1_Open_Requirements_Tool.sdoc

Large diffs are not rendered by default.

171 changes: 117 additions & 54 deletions docs/strictdoc_21_L2_StrictDoc_Requirements.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -737,23 +737,6 @@ RELATIONS:
- TYPE: File
VALUE: strictdoc/server/routers/main_router.py

[REQUIREMENT]
MID: f2fd90ad8a2946e7b085233a9c7a8a75
UID: SDOC-SRS-51
STATUS: Active
TITLE: Export to HTML content to PDF (HTML2PDF)
STATEMENT: >>>
StrictDoc shall allow exporting documents and entire documentation trees to PDF.
<<<
RATIONALE: >>>
As required by the parent requirement, PDF is one of the most common documentation formats.
<<<
RELATIONS:
- TYPE: Parent
VALUE: DO178-5
- TYPE: Parent
VALUE: SDOC-SSS-96

[REQUIREMENT]
MID: 8811f0ef33de4365bc66a602a8c184f6
UID: SDOC-SRS-48
Expand Down Expand Up @@ -849,6 +832,18 @@ RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-3

[REQUIREMENT]
MID: 9b291b5df5914f13b23fb8c367be0a24
UID: SDOC-SRS-161
STATUS: Active
TITLE: Clone node from existing node
STATEMENT: >>>
StrictDoc shall support cloning nodes from existing nodes.
<<<
RATIONALE: >>>
Simplifies the creation of similar nodes.
<<<

[REQUIREMENT]
MID: 13968ae160744e10ba8979eaee2f4f54
UID: SDOC-SRS-55
Expand All @@ -861,6 +856,15 @@ RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-4

[REQUIREMENT]
MID: 0ec87f08626a4839b5951d98fef9e0e1
UID: SDOC-SRS-162
STATUS: Active
TITLE: Delete node
STATEMENT: >>>
StrictDoc's Document screen shall support the deletion of document nodes.
<<<

[REQUIREMENT]
MID: b805e36294764e8f8cb5a88ab8fa0467
UID: SDOC-SRS-159
Expand Down Expand Up @@ -1043,6 +1047,38 @@ RELATIONS:

[[/SECTION]]

[[SECTION]]
MID: 181dfbcbbfac41e18f7fb09af0df8f4e
TITLE: Screen: HTML2PDF

[REQUIREMENT]
MID: f2fd90ad8a2946e7b085233a9c7a8a75
UID: SDOC-SRS-51
STATUS: Active
TITLE: Export to HTML content to PDF (HTML2PDF)
STATEMENT: >>>
StrictDoc shall allow exporting documents and entire documentation trees to PDF.
<<<
RATIONALE: >>>
As required by the parent requirement, PDF is one of the most common documentation formats.
<<<
RELATIONS:
- TYPE: Parent
VALUE: DO178-5
- TYPE: Parent
VALUE: SDOC-SSS-96

[REQUIREMENT]
MID: 6cfcb21b3f1949f49d13af6b00d3d37a
UID: SDOC-SRS-160
STATUS: Active
TITLE: Custom PDF export template
STATEMENT: >>>
StrictDoc shall support the customization of the PDF export template.
<<<

[[/SECTION]]

[[SECTION]]
MID: ddf15b3113a54107979752ec192e2ded
TITLE: Screen: Project statistics
Expand Down Expand Up @@ -1118,6 +1154,55 @@ RELATIONS:

[[/SECTION]]

[[SECTION]]
MID: 63df985038374acb82e9b4185eff5a7e
TITLE: Screen: Source coverage

[REQUIREMENT]
MID: 3aeb1eea0dba4041a9161a1a8d291999
UID: SDOC-SRS-35
STATUS: Active
TITLE: Project source code coverage
STATEMENT: >>>
StrictDoc shall generate project source code coverage information.

NOTE: Source code information can be visualized using both web or CLI interfaces.
<<<
RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-72
- TYPE: Parent
VALUE: DO178-13
- TYPE: File
FORMAT: Sourcecode
VALUE: strictdoc/export/html/generators/source_file_coverage.py

[[/SECTION]]

[[SECTION]]
MID: 9c19eea544ec4d90bb65fd8fd9b13cc4
TITLE: Screen: Single source file coverage

[REQUIREMENT]
MID: 56ecfb19152e45b09c0e55de2d1d5f05
UID: SDOC-SRS-36
STATUS: Active
TITLE: Single source file coverage
STATEMENT: >>>
StrictDoc shall generate single file traceability information.
<<<
RATIONALE: >>>
With this capability in place, it is possible to focus on a single implementation file's links to requirements which helps in the code reviews and inspections.
<<<
RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-72
- TYPE: File
FORMAT: Sourcecode
VALUE: strictdoc/export/html/generators/source_file_view_generator.py

[[/SECTION]]

[[SECTION]]
MID: 14ad600308434e6baaeef02d3e90b720
TITLE: Screen: Traceability matrix
Expand Down Expand Up @@ -1443,43 +1528,6 @@ A reference example: Generating test specifications from the TEST_SPEC nodes whi

[[/SECTION]]

[REQUIREMENT]
MID: 3aeb1eea0dba4041a9161a1a8d291999
UID: SDOC-SRS-35
STATUS: Active
TITLE: Generate project source code coverage
STATEMENT: >>>
StrictDoc shall generate project source code coverage information.

NOTE: Source code information can be visualized using both web or CLI interfaces.
<<<
RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-72
- TYPE: Parent
VALUE: DO178-13
- TYPE: File
FORMAT: Sourcecode
VALUE: strictdoc/export/html/generators/source_file_coverage.py

[REQUIREMENT]
MID: 56ecfb19152e45b09c0e55de2d1d5f05
UID: SDOC-SRS-36
STATUS: Active
TITLE: Generate single source file coverage
STATEMENT: >>>
StrictDoc shall generate single file traceability information.
<<<
RATIONALE: >>>
With this capability in place, it is possible to focus on a single implementation file's links to requirements which helps in the code reviews and inspections.
<<<
RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-72
- TYPE: File
FORMAT: Sourcecode
VALUE: strictdoc/export/html/generators/source_file_view_generator.py

[[/SECTION]]

[[SECTION]]
Expand Down Expand Up @@ -1753,6 +1801,18 @@ RELATIONS:
MID: 44eb09d0e5b542d5984d234167e6f337
TITLE: User experience

[REQUIREMENT]
MID: 2bfb3703b218411b87864733bffb59cf
UID: SDOC-SRS-163
STATUS: Active
TITLE: StrictDoc identification
STATEMENT: >>>
StrictDoc shall provide 'about' and 'version' commands that display the project's title, current version, license, and links to the project's web pages.
<<<
RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-97

[[SECTION]]
MID: 821c01118a9643a188a4ecc5b0cec6a5
UID: SECTION-SSRS-Strict-mode-by-default
Expand All @@ -1766,6 +1826,9 @@ TITLE: Warnings are errors
STATEMENT: >>>
StrictDoc's default mode of operation shall treat all warnings as errors.
<<<
RATIONALE: >>>
When warnings are treated as errors, the user becomes aware of potential issues as soon as they appear.
<<<
RELATIONS:
- TYPE: Parent
VALUE: SDOC-SSS-78
Expand Down
4 changes: 4 additions & 0 deletions strictdoc/commands/about_command.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-163, scope=file)
"""

import strictdoc


Expand Down
4 changes: 4 additions & 0 deletions strictdoc/commands/version_command.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-163, scope=file)
"""

import strictdoc


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-155, scope=file)
"""

import os

from tests.end2end.e2e_case import E2ECase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-51, scope=file)
"""

import os
import shutil

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-51, scope=file)
"""

import os
import shutil

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-161, scope=file)
"""

from selenium.webdriver.common.by import By

from tests.end2end.e2e_case import E2ECase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-161, scope=file)
"""

from selenium.webdriver.common.by import By

from tests.end2end.e2e_case import E2ECase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.project_index.screen_project_index import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-162, scope=file)
"""

from tests.end2end.e2e_case import E2ECase
from tests.end2end.end2end_test_setup import End2EndTestSetup
from tests.end2end.helpers.screens.document.form_edit_requirement import (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-72, scope=file)
"""

import filecmp
import os
import shutil
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-160, scope=file)
"""

import os

from tests.end2end.e2e_case import E2ECase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-72, scope=file)
"""

import os
import shutil
import sys
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-72, scope=file)
"""

import os

from tests.end2end.e2e_case import E2ECase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-72, scope=file)
"""

import os

from tests.end2end.e2e_case import E2ECase
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
@relation(SDOC-SRS-72, scope=file)
"""

import os

from tests.end2end.e2e_case import E2ECase
Expand Down
Loading
Loading