Tool Requirements

📈 Status

This section provides an overview of current process requirements and their clarification & implementation status.

Note

All open issues and pull requests in the process repository are considered as if they are already part of the process requirements. They address a lot of the requirements that are referenced in this document, so we would be blocked if we would not consider them as part of the process requirements.

🗂️ Common Attributes

Note

To stay consistent with sphinx-needs (the tool behind docs-as-code), we’ll use need for any kind of model element like a requirement, an architecture element or a feature description.

🔢 ID

Enforces need ID uniqueness		status: valid security: NO safety: ASIL_B
tags: Common Attributes implemented: YES parent_covered: NO satisfies: gd_req__req_attr_uid, gd_req__tool_attr_uid, gd_req__arch_attribute_uid, gd_req__saf_attr_uid
Docs-as-Code shall enforce that all Need IDs are globally unique across all included documentation instances. Note Within each docs-instance (as managed by sphinx-needs), IDs are guaranteed to be unique. When linking across instances, unique prefixes are automatically applied to maintain global uniqueness.
tool_req__docs_common_attr_id		Tool Requirement

Enforces need ID scheme		status: valid security: NO safety: ASIL_B
tags: Common Attributes implemented: PARTIAL parent_covered: NO: cannot check non-existent "doc__naming_conventions" in gd_req__req_attr_uid source_code_link: src/extensions/score_metamodel/checks/attributes_format.py:30; satisfies: gd_req__req_attr_uid, gd_req__arch_attribute_uid, gd_req__saf_attr_uid, gd_req__req_check_mandatory
Docs-as-Code shall enforce that Need IDs follow the following naming scheme: A prefix indicating the need type (e.g. feature__) A middle part matching the hierarchical structure of the need: For requirements: a portion of the feature tree or a component acronym For architecture elements: the structural element (e.g. a part of the feature tree, component acronym) For safety analysis (FMEA, DFA): name of analyzed structural element (e.g. Persistency, FEO, etc.) Additional descriptive text to ensure human readability
tool_req__docs_common_attr_id_scheme		Tool Requirement

🏷️ Title

Enforces title wording rules		status: valid security: NO safety: ASIL_B
tags: Common Attributes, config implemented: YES parent_covered: NO: Can not ensure summary source_code_link: src/extensions/score_metamodel/metamodel.yaml:33; src/extensions/score_metamodel/checks/attributes_format.py:110; satisfies: gd_req__req_attr_title, gd_req__saf_attr_title, tool_req__docs_metamodel
Docs-as-Code shall enforce that all needs have titles and titles do not contain the following words: shall must will
tool_req__docs_common_attr_title		Tool Requirement

📝 Description

Enforces presence of description		status: valid security: NO safety: ASIL_B
tags: Common Attributes implemented: YES parent_covered: NO: Can not cover 'ISO/IEC/IEEE/29148' satisfies: gd_req__req_attr_description, gd_req__req_check_mandatory
Docs-as-Code shall enforce that each need of type Requirements Types (tool_req__docs_req_types) has a description (content)
tool_req__docs_common_attr_description		Tool Requirement

Enforces description wording rules		status: valid security: NO safety: ASIL_B
tags: Common Attributes, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:39; src/extensions/score_metamodel/checks/attributes_format.py:109; satisfies: gd_req__req_desc_weak, tool_req__docs_metamodel
Docs-as-Code shall enforce that requirement descriptions do not contain the following weak words: ju-st, ab-out, rea-lly, so-me, th-ing, absol-utely This rule applies to: all requirement types defined in Requirements Types (tool_req__docs_req_types), except process requirements. Note Artificial “-” added to avoid triggering violation of this requirment in this document.
tool_req__docs_common_attr_desc_wording		Tool Requirement

🔒 Security Classification

Security: enforce classification		status: valid security: NO safety: ASIL_B
tags: Common Attributes, config implemented: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:258; src/extensions/score_metamodel/metamodel.yaml:283; src/extensions/score_metamodel/metamodel.yaml:317; src/extensions/score_metamodel/metamodel.yaml:346; src/extensions/score_metamodel/metamodel.yaml:379; src/extensions/score_metamodel/metamodel.yaml:409; src/extensions/score_metamodel/metamodel.yaml:430; src/extensions/score_metamodel/metamodel.yaml:453; src/extensions/score_metamodel/metamodel.yaml:476; src/extensions/score_metamodel/metamodel.yaml:497; src/extensions/score_metamodel/metamodel.yaml:517; src/extensions/score_metamodel/metamodel.yaml:559; src/extensions/score_metamodel/metamodel.yaml:580; src/extensions/score_metamodel/metamodel.yaml:603; src/extensions/score_metamodel/metamodel.yaml:624; src/extensions/score_metamodel/metamodel.yaml:645; src/extensions/score_metamodel/checks/check_options.py:151; satisfies: gd_req__req_attr_security, gd_req__arch_attr_security, gd_req__req_check_mandatory, tool_req__docs_metamodel
Docs-as-Code shall enforce that the security attribute has one of the following values: YES NO This rule applies to: all requirement types defined in Requirements Types (tool_req__docs_req_types), except process and tool requirements. all architecture elements defined in Architecture Types (tool_req__docs_arch_types).
tool_req__docs_common_attr_security		Tool Requirement

🛡️ Safety Classification

Safety: enforce classification		status: valid security: NO safety: ASIL_B
tags: Common Attributes, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:250; src/extensions/score_metamodel/metamodel.yaml:285; src/extensions/score_metamodel/metamodel.yaml:319; src/extensions/score_metamodel/metamodel.yaml:348; src/extensions/score_metamodel/metamodel.yaml:381; src/extensions/score_metamodel/metamodel.yaml:411; src/extensions/score_metamodel/metamodel.yaml:432; src/extensions/score_metamodel/metamodel.yaml:455; src/extensions/score_metamodel/metamodel.yaml:478; src/extensions/score_metamodel/metamodel.yaml:499; src/extensions/score_metamodel/metamodel.yaml:519; src/extensions/score_metamodel/metamodel.yaml:561; src/extensions/score_metamodel/metamodel.yaml:582; src/extensions/score_metamodel/metamodel.yaml:605; src/extensions/score_metamodel/metamodel.yaml:626; src/extensions/score_metamodel/metamodel.yaml:647; src/extensions/score_metamodel/checks/check_options.py:152; satisfies: gd_req__req_check_mandatory, gd_req__req_attr_safety, gd_req__arch_attr_safety, tool_req__docs_metamodel
Docs-as-Code shall enforce that the safety attribute has one of the following values: QM ASIL_B This rule applies to: all requirement types defined in Requirements Types (tool_req__docs_req_types), except process and tool requirements. all architecture elements defined in Architecture Types (tool_req__docs_arch_types).
tool_req__docs_common_attr_safety		Tool Requirement

🚦 Status

Status: enforce attribute		status: valid security: NO safety: ASIL_B
tags: Common Attributes, config implemented: YES parent_covered: NO: gd_req__saf_attr_status has additional constraints source_code_link: src/extensions/score_metamodel/metamodel.yaml:125; src/extensions/score_metamodel/metamodel.yaml:252; src/extensions/score_metamodel/metamodel.yaml:287; src/extensions/score_metamodel/metamodel.yaml:321; src/extensions/score_metamodel/metamodel.yaml:350; src/extensions/score_metamodel/metamodel.yaml:383; src/extensions/score_metamodel/metamodel.yaml:413; src/extensions/score_metamodel/metamodel.yaml:434; src/extensions/score_metamodel/metamodel.yaml:457; src/extensions/score_metamodel/metamodel.yaml:480; src/extensions/score_metamodel/metamodel.yaml:501; src/extensions/score_metamodel/metamodel.yaml:521; src/extensions/score_metamodel/metamodel.yaml:563; src/extensions/score_metamodel/metamodel.yaml:584; src/extensions/score_metamodel/metamodel.yaml:607; src/extensions/score_metamodel/metamodel.yaml:628; src/extensions/score_metamodel/metamodel.yaml:649; src/extensions/score_metamodel/checks/check_options.py:153; satisfies: gd_req__req_attr_status, gd_req__arch_attr_status, gd_req__saf_attr_status, gd_req__req_check_mandatory, tool_req__docs_metamodel
Docs-as-Code shall enforce that the status attribute has one of the following values: valid invalid This rule applies to: all requirement types defined in Requirements Types (tool_req__docs_req_types), except process and tool requirements. all architecture elements defined in Architecture Types (tool_req__docs_arch_types). all safety analysis elements defined in Safety Analysis Need Types (tool_req__docs_saf_types).
tool_req__docs_common_attr_status		Tool Requirement

Versioning

Versioning: enforce attribute		status: valid security: NO safety: ASIL_B
tags: Common Attributes implemented: NO parent_covered: NO: to be checked after demo satisfies: gd_req__req_attr_version
Docs-As-Code shall enable and enforce a versioning attribute for all needs. Note Exact nature to be decided, it could e.g. be a number, a string, a semantic version, a date or a hash.
tool_req__docs_common_attr_version		Tool Requirement

Suspicious: Enforce attribute		status: invalid security: NO safety: ASIL_B
tags: Common Attributes implemented: NO parent_covered: NO: parent talks about setting covered to false, but we want to issue a build error. satisfies: gd_req__req_suspicious
Docs-as-Code shall check if linked parent needs have different versions, compared to the version the need was originally linked to.
tool_req__docs_common_attr_suspicious		Tool Requirement

📚 Documents

Document Types		status: valid security: NO safety: ASIL_B
tags: Documents, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:201; src/extensions/score_metamodel/metamodel.yaml:220; satisfies: gd_req__doc_types, tool_req__docs_metamodel
Docs-as-Code shall support the following document types: Generic Document (document) Tool Verification Report (doc_tool) Change Request is also a generic document
tool_req__docs_doc_types		Tool Requirement

Mandatory attributes of Generic Documents		status: valid security: NO safety: ASIL_B
tags: Documents, config implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:205; src/extensions/score_metamodel/metamodel.yaml:215; satisfies: gd_req__doc_attributes_manual, gd_req__change_attr_impact_safety, tool_req__docs_metamodel
Docs-as-Code shall enforce that each Generic Document doc__* has the following attributes: status security safety realizes
tool_req__docs_doc_generic_mandatory		Tool Requirement

Mandatory Document attributes		status: invalid security: NO safety: ASIL_B
tags: Documents, config implemented: NO parent_covered: NO, process requirement has changed and we do not understand the new wording. source_code_link: src/extensions/score_metamodel/metamodel.yaml:211; src/extensions/score_metamodel/metamodel.yaml:235; satisfies: gd_req__doc_author, gd_req__doc_approver, gd_req__doc_reviewer, gd_req__change_attr_title, tool_req__docs_metamodel
Docs-as-Code shall enforce that each Document Types (tool_req__docs_doc_types) has the following attributes: title (implicitly enforced by sphinx-needs) author approver reviewer
tool_req__docs_doc_attr		Tool Requirement

Document author is autofilled		status: invalid security: NO safety: ASIL_B
tags: Documents implemented: NO parent_covered: NO, process requirement has changed and we do not understand the new wording. satisfies: gd_req__doc_author
Docs-as-Code shall provide an automatic mechanism to determine document authors. Contributors responsible for more than 50% of the content shall be considered the document author. Contributors are accumulated over all commits to the file containing the document. Note The requirement is currently invalid as it’s currently unclear how the contribution % are counted and how to accumulate %.
tool_req__docs_doc_attr_author_autofill		Tool Requirement

Document approver is autofilled		status: invalid security: NO safety: ASIL_B
tags: Documents implemented: NO parent_covered: NO, process requirement has changed and we do not understand the new wording. satisfies: gd_req__doc_approver
Docs-as-Code shall provide an automatic mechanism to determine the document approver. The approver shall be the approvers listed in CODEOWNERS of the last pull request of the file containing the document.
tool_req__docs_doc_attr_approver_autofill		Tool Requirement

Document reviewer is autofilled		status: invalid security: NO safety: ASIL_B
tags: Documents implemented: NO parent_covered: NO, process requirement has changed and we do not understand the new wording. satisfies: gd_req__doc_reviewer
Docs-as-Code shall provide an automatic mechanism to determine the document reviewers. The reviewer shall be the approvers NOT listed in CODEOWNERS of the last pull request of the file containing the document.
tool_req__docs_doc_attr_reviewer_autofill		Tool Requirement

Mapping

ID	tool_req
gd_req__doc_approver	tool_req__docs_doc_attr_approver_autofill; tool_req__docs_doc_attr
gd_req__doc_attributes_manual	tool_req__docs_doc_generic_mandatory
gd_req__doc_author	tool_req__docs_doc_attr_author_autofill; tool_req__docs_doc_attr
gd_req__doc_reviewer	tool_req__docs_doc_attr_reviewer_autofill; tool_req__docs_doc_attr
gd_req__doc_types	tool_req__docs_doc_types

📋 Requirements

🔢 Requirement Types

Requirements Types		status: valid security: NO safety: ASIL_B
tags: Requirements, config implemented: YES parent_covered: YES: Together with tool_req__docs_linkage source_code_link: src/extensions/score_metamodel/metamodel.yaml:121; src/extensions/score_metamodel/metamodel.yaml:244; src/extensions/score_metamodel/metamodel.yaml:276; src/extensions/score_metamodel/metamodel.yaml:311; src/extensions/score_metamodel/metamodel.yaml:342; src/extensions/score_metamodel/metamodel.yaml:373; satisfies: gd_req__req_structure, tool_req__docs_metamodel
Docs-as-Code shall support the following requirement types: Stakeholder requirement (stkh_req) Feature requirement (feat_req) Component requirement (comp_req) Assumption of use requirement (aou_req) Process requirement (gd_req) Tool requirement (tool_req)
tool_req__docs_req_types		Tool Requirement

🏷️ Attributes

Enforces rationale attribute		status: valid security: NO safety: ASIL_B
tags: Requirements, config implemented: YES parent_covered: NO: Can not ensure correct reasoning source_code_link: src/extensions/score_metamodel/metamodel.yaml:256; src/extensions/score_metamodel/checks/check_options.py:154; satisfies: gd_req__req_attr_rationale, gd_req__req_check_mandatory, tool_req__docs_metamodel
Docs-as-Code shall enforce that each stakeholder requirement (stkh_req) contains a rationale attribute.
tool_req__docs_req_attr_rationale		Tool Requirement

Enforces requirement type classification		status: valid security: NO safety: ASIL_B
tags: Requirements, config implemented: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:248; src/extensions/score_metamodel/metamodel.yaml:281; src/extensions/score_metamodel/metamodel.yaml:315; src/extensions/score_metamodel/metamodel.yaml:377; src/extensions/score_metamodel/checks/check_options.py:150; satisfies: gd_req__req_attr_type, tool_req__docs_metamodel
Docs-as-Code shall enforce that each need of type Requirements Types (tool_req__docs_req_types) except process and tool requirements has a reqtype attribute with one of the following values: Functional Interface Process Non-Functional
tool_req__docs_req_attr_reqtype		Tool Requirement

Enables marking requirements as "covered"		status: valid security: NO safety: ASIL_B
tags: Requirements, config implemented: PARTIAL source_code_link: src/extensions/score_metamodel/metamodel.yaml:263; src/extensions/score_metamodel/metamodel.yaml:296; src/extensions/score_metamodel/metamodel.yaml:330; src/extensions/score_metamodel/metamodel.yaml:360; src/extensions/score_metamodel/metamodel.yaml:389; satisfies: gd_req__req_attr_req_cov, tool_req__docs_metamodel
Docs as code shall shall enable marking requirements as covered by their linked children. Attribute reqcov must be one of the following values: Yes No Note No concept yet, as parents are generally not aware of their children.
tool_req__docs_req_attr_reqcov		Tool Requirement

Support requirements test coverage		status: invalid security: NO safety: ASIL_B
tags: Requirements, config implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:265; src/extensions/score_metamodel/metamodel.yaml:298; src/extensions/score_metamodel/metamodel.yaml:332; src/extensions/score_metamodel/metamodel.yaml:362; src/extensions/score_metamodel/metamodel.yaml:391; satisfies: gd_req__req_attr_test_covered, tool_req__docs_metamodel
Docs-As-Code shall allow for every need of type Requirements Types (tool_req__docs_req_types) to have a testcovered attribute, which must be one of: Yes No Note No concept yet
tool_req__docs_req_attr_testcov		Tool Requirement

Enforce validity attribute correctness		status: valid security: NO safety: ASIL_B
tags: Requirements, config implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:268; src/extensions/score_metamodel/metamodel.yaml:301; satisfies: gd_req__req_validity, tool_req__docs_metamodel
Docs-as-Code shall enforce that the valid_from and valid_until attributes of stakeholder and feature requirements are correct. The format of a milestone is something like “v0.5” or “v1.0.1”. No suffixes like “-SNAPSHOT” or “-beta” are allowed.
tool_req__docs_req_attr_validity_correctness		Tool Requirement

Enforce validity start is before end		status: valid security: NO safety: ASIL_B
tags: Requirements implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_metamodel/checks/check_options.py:223; satisfies: gd_req__req_validity
Docs-as-Code shall enforce that valid_from is before valid_until attribute in stakeholder and feature requirements. We consider “from” is inclusive but “until” is exclusive, so from v0.5 until v1.0 means valid for v0.5 but not for v1.0. If either attribute is missing, no check is performed.
tool_req__docs_req_attr_validity_consistency		Tool Requirement

🔗 Links

Enables needs linking via satisfies attribute		status: invalid security: NO safety: ASIL_B
tags: Requirements, config implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:129; src/extensions/score_metamodel/metamodel.yaml:291; src/extensions/score_metamodel/metamodel.yaml:325; src/extensions/score_metamodel/metamodel.yaml:354; satisfies: gd_req__req_linkage, gd_req__req_traceability, tool_req__docs_metamodel
Docs-as-Code shall enforce that linking between model elements via the satisfies attribute follows defined rules. Having at least one link is mandatory. Allowed source and target combinations are defined in the following table: Source Type Allowed Link Target Feature Requirements Stakeholder Requirements Component Requirements Feature Requirements Process Requirements Workflows Tooling Requirements Process Requirements, Stakeholder Requirements Note Certain tool requirements do not have a matching process requirement.
tool_req__docs_req_link_satisfies_allowed		Tool Requirement

Safety: enforce safe linking		status: valid security: NO safety: ASIL_B
tags: Common Attributes, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:992; satisfies: gd_req__req_linkage_safety, tool_req__docs_metamodel
QM requirements (safety == QM) shall not be linked to safety requirements (safety != QM) via the satisfies attribute.
tool_req__docs_common_attr_safety_link_check		Tool Requirement

🏛️ Architecture

🔢 Architecture Types

Architecture Types		status: invalid security: NO safety: ASIL_B
tags: Architecture, config implemented: YES parent_covered: NO source_code_link: src/extensions/score_metamodel/metamodel.yaml:423; src/extensions/score_metamodel/metamodel.yaml:469; src/extensions/score_metamodel/metamodel.yaml:491; src/extensions/score_metamodel/metamodel.yaml:617; src/extensions/score_metamodel/metamodel.yaml:639; satisfies: gd_req__arch_hierarchical_structure, gd_req__arch_build_blocks, tool_req__docs_metamodel
Docs-as-Code shall support the following architecture element types: Feature (feat_arc_sta) Logical Interface (logic_arc_int) Logical Interface Operation (logic_arc_int_op) Component (comp_arc_sta) Interface (real_arc_int) Interface Operation (real_arc_int_op)
tool_req__docs_arch_types		Tool Requirement

Architecture Attributes

Architecture Mandatory Attributes		status: valid security: NO safety: ASIL_B
tags: Architecture implemented: PARTIAL parent_covered: YES parent_has_problem: YES: Metamodel & Process aren't the same. Some definitions are not consistent in Process source_code_link: src/extensions/score_metamodel/checks/check_options.py:155; satisfies: gd_req__arch_attr_mandatory, gd_req__arch_attr_fulfils
Docs-as-Code shall enforce that the following attributes are present in all needs of type Architecture Types (tool_req__docs_arch_types) Fulfils Safety Security Status UID
tool_req__docs_arch_attr_mandatory		Tool Requirement

🔗 Linkage

Mandatory Architecture Attribute: fulfils		status: valid security: NO safety: ASIL_B
tags: Architecture implemented: PARTIAL parent_covered: YES satisfies: gd_req__arch_linkage_requirement_type, gd_req__arch_attr_fulfils, gd_req__arch_traceability, gd_req__req_linkage_fulfill
Docs-as-Code shall enforce that linking via the fulfils attribute follows defined rules. Allowed source and target combinations are defined in the following table: Link Source Allowed Link Target feat_arc_sta feat_req feat_arc_dyn feat_req logic_arc_int feat_req comp_arc_sta comp_req comp_arc_dyn comp_req real_arc_int comp_req
tool_req__docs_arch_link_fulfils		Tool Requirement

Ensure safety architecture elements link a safety requirement		status: valid security: NO safety: ASIL_B
tags: Architecture implemented: PARTIAL parent_covered: YES satisfies: gd_req__arch_linkage_requirement
Docs-as-Code shall enforce that architecture elements of type Architecture Types (tool_req__docs_arch_types) with safety != QM are linked to at least one requirements of type Requirements Types (tool_req__docs_req_types) with the exact same safety value.
tool_req__docs_arch_link_safety_to_req		Tool Requirement

Ensure qm architecture elements do not fulfill safety requirements		status: valid security: NO safety: ASIL_B
tags: Architecture, config implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:1001; satisfies: gd_req__arch_linkage_requirement, tool_req__docs_metamodel
Docs-as-Code shall enforce that architecture elements of type Architecture Types (tool_req__docs_arch_types) with safety == QM are not linked to requirements of type Requirements Types (tool_req__docs_req_types) with safety != QM.
tool_req__docs_arch_link_qm_to_safety_req		Tool Requirement

Restrict links for safety requirements		status: valid security: NO safety: ASIL_B
tags: Architecture, config implemented: PARTIAL parent_covered: NO source_code_link: src/extensions/score_metamodel/metamodel.yaml:1010; satisfies: gd_req__arch_linkage_safety_trace, gd_req__req_linkage_safety, tool_req__docs_metamodel
Docs-as-Code shall enforce that valid safety architectural elements (Safety != QM) can only be linked against valid safety architectural elements.
tool_req__docs_req_arch_link_safety_to_arch		Tool Requirement

Security: Restrict linkage		status: valid security: NO safety: ASIL_B
tags: Architecture, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:1025; satisfies: gd_req__arch_linkage_security_trace, tool_req__docs_metamodel
Docs-as-Code shall enforce that security relevant Architecture Types (tool_req__docs_arch_types) (Security == YES) can only be linked against security relevant Architecture Types (tool_req__docs_arch_types).
tool_req__docs_arch_link_security		Tool Requirement

🖼️ Diagram Related

Support Diagram drawing of architecture		status: valid security: NO safety: ASIL_B
tags: Architecture, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:424; src/extensions/score_metamodel/metamodel.yaml:447; src/extensions/score_metamodel/metamodel.yaml:470; src/extensions/score_metamodel/metamodel.yaml:530; src/extensions/score_metamodel/metamodel.yaml:574; src/extensions/score_metamodel/metamodel.yaml:597; src/extensions/score_metamodel/metamodel.yaml:618; satisfies: gd_req__arch_viewpoints, tool_req__docs_metamodel
Docs-as-Code shall enable the rendering of diagrams for the following architecture views: Feature Package Diagram (feat_arc_sta) Feature Sequence Diagram (feat_arc_dyn) Feature Interface View (logic_arc_int) Component Package Diagram (comp_arc_sta) Component Sequence Diagram (comp_arc_dyn) Component Interface (real_arc_int) Module View (mod_view_sta) Note feat_arc_sta, comp_arc_sta, logic_arc_int, real_arc_int are architecture elements AND architecture views.
tool_req__docs_arch_views		Tool Requirement

💻 Detailed Design & Code

🔗 Code Linkage

Supports linking to source code		status: valid security: NO safety: ASIL_B
tags: Detailed Design & Code, config implemented: YES parent_covered: NO: we only enable linking, we do not link source_code_link: src/extensions/score_metamodel/metamodel.yaml:17; src/extensions/score_source_code_linker/needlinks.py:13; src/extensions/score_source_code_linker/need_source_links.py:20; satisfies: gd_req__req_attr_impl, gd_req__impl_design_code_link, tool_req__docs_metamodel
Docs-as-Code shall allow source code to link to needs. A link to the corresponding source code location in GitHub shall be generated in the generated documentation within the linked requirement.
tool_req__docs_dd_link_source_code_link		Tool Requirement

Feature Flags		status: valid security: NO safety: ASIL_B
tags: Detailed Design & Code implemented: NO parent_covered: YES satisfies: gd_req__req_linkage_architecture_switch
Docs-as-Code shall allow for a to-be-defined list of checks to be non-fatal for non release builds. These are typically better suited for metrics than for checks. e.g. gd_req__req_linkage_architecture
tool_req__docs_dd_feature_flag		Tool Requirement

Static Diagram for Unit Interactions		status: valid security: NO safety: ASIL_B
tags: Detailed Design & Code, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:671; satisfies: gd_req__impl_static_diagram, tool_req__docs_metamodel
Provide needs type dd_sta for static diagrams showing unit interactions as UML.
tool_req__docs_dd_sta		Tool Requirement

Dynamic Diagram for Unit Interactions		status: valid security: NO safety: ASIL_B
tags: Detailed Design & Code, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:688; satisfies: gd_req__impl_dynamic_diagram, tool_req__docs_metamodel
Provide needs type dd_dyn for dynamic diagrams showing unit interactions as UML.
tool_req__docs_dd_dyn		Tool Requirement

Testing

Supports linking to test cases		status: valid security: NO safety: ASIL_B
tags: Testing implemented: PARTIAL parent_covered: YES source_code_link: src/extensions/score_source_code_linker/testlink.py:21; src/extensions/score_source_code_linker/xml_parser.py:19; src/extensions/score_source_code_linker/need_source_links.py:19; satisfies: gd_req__req_attr_testlink
Docs-as-Code shall allow requirements of type Requirements Types (tool_req__docs_req_types) to include a testlink attribute. This attribute shall support linking test cases to requirements.
tool_req__docs_test_link_testcase		Tool Requirement

Extract Metadata from Tests		status: valid security: NO safety: ASIL_B
tags: Testing implemented: NO parent_covered: NO satisfies: gd_req__verification_checks
Docs-as-Code shall ensure that each test case has TestType and DerivationTechnique set.
tool_req__docs_test_metadata_mandatory_1		Tool Requirement

Extract Metadata from Tests		status: invalid security: NO safety: ASIL_B
tags: Testing implemented: NO parent_covered: NO satisfies: gd_req__verification_checks
Docs-as-Code shall ensure that each test case has a non empty description. Note this will probably be implemented outside of docs-as-code.
tool_req__docs_test_metadata_mandatory_2		Tool Requirement

Extract Metadata from Tests		status: invalid security: NO safety: ASIL_B
tags: Testing implemented: NO parent_covered: NO satisfies: gd_req__verification_checks
Docs-as-Code shall ensure that test cases link to requirements on the correct level: If Partially/FullyVerifies are set in Feature Integration Test these shall link to Feature Requirements If Partially/FullyVerifies are set in Component Integration Test these shall link to Component Requirements If Partially/FullyVerifies are set in Unit Test these shall link to Component Requirements
tool_req__docs_test_metadata_link_levels		Tool Requirement

🧪 Tool Verification Reports

Enforce safety classification		status: valid security: NO safety: ASIL_B
tags: Tool Verification Reports, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:228; satisfies: gd_req__tool_attr_safety_affected, gd_req__tool_check_mandatory, tool_req__docs_metamodel
Docs-as-Code shall enforce that every Tool Verification Report (doc_tool) includes a safety_affected attribute with one of the following values: YES NO
tool_req__docs_tvr_safety		Tool Requirement

Enforce security classification		status: valid security: NO safety: ASIL_B
tags: Tool Verification Reports, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:230; satisfies: gd_req__tool_attr_security_affected, gd_req__tool_check_mandatory, tool_req__docs_metamodel
Docs-as-Code shall enforce that every Tool Verification Report (doc_tool) includes a security_affected attribute with one of the following values: YES NO
tool_req__docs_tvr_security		Tool Requirement

Enforce status classification		status: valid security: NO safety: ASIL_B
tags: Tool Verification Reports, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:224; satisfies: gd_req__tool_attr_status, gd_req__tool_check_mandatory, tool_req__docs_metamodel
Docs-as-Code shall enforce that every Tool Verification Report (doc_tool) includes a status attribute with one of the following values: draft evaluated qualified released rejected
tool_req__docs_tvr_status		Tool Requirement

Enforce version attribute		status: valid security: NO safety: ASIL_B
tags: Tool Verification Reports, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:226; satisfies: gd_req__tool_attr_version, tool_req__docs_metamodel
Docs-as-Code shall enforce that every Tool Verification Report (doc_tool) includes a version attribute.
tool_req__docs_tvr_version		Tool Requirement

Enforce confidence level classification		status: valid security: NO safety: ASIL_B
tags: Tool Verification Reports, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:232; satisfies: gd_req__tool_attr_tcl, tool_req__docs_metamodel
Docs-as-Code shall enforce that every Tool Verification Report (doc_tool) includes a tcl attribute with one of the following values: LOW HIGH
tool_req__docs_tvr_confidence_level		Tool Requirement

⚙️ Process / Other

Workflow Types		status: valid security: NO safety: ASIL_B
tags: Process / Other, config implemented: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:104; satisfies: gd_req__process_management_build_blocks_attr, gd_req__process_management_build_blocks_link, tool_req__docs_metamodel
Docs-as-Code shall support the following workflow types: Workflow (wf)
tool_req__docs_wf_types		Tool Requirement

Standard Requirement Types		status: valid security: NO safety: ASIL_B
tags: Process / Other, config implemented: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:86; satisfies: tool_req__docs_metamodel
Docs-as-Code shall support the following requirement types: Standard requirement (std_req)
tool_req__docs_stdreq_types		Tool Requirement

🛡️ Safety Analysis (DFA + FMEA)

Safety Analysis Need Types		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:740; src/extensions/score_metamodel/metamodel.yaml:767; src/extensions/score_metamodel/metamodel.yaml:795; src/extensions/score_metamodel/metamodel.yaml:822; satisfies: gd_req__saf_structure, gd_req__saf_attr_uid, tool_req__docs_metamodel
Docs-As-Code shall support the following need types: Feature FMEA (Failure Modes and Effect Analysis) -> feat_saf_fmea Component FMEA (Failure Modes and Effect Analysis) -> comp_saf_fmea Feature DFA (Dependend Failure Analysis) -> feat_saf_dfa Component DFA (Dependent Failure Analysis) -> comp_saf_dfa
tool_req__docs_saf_types		Tool Requirement

Safety Analysis Mandatory Attributes		status: valid security: NO safety: ASIL_B
tags: Safety Analysis implemented: YES parent_covered: YES satisfies: gd_req__saf_attr_mandatory
All safety analysis elements in Safety Analysis Need Types (tool_req__docs_saf_types) shall have the following mandatory attributes: DFA-only attribute: failure_id FMEA-only attribute: fault_id attribute: failure_effect attribute: status attribute: sufficient attribute: title (all Needs elements have a title) attribute: id (all Needs elements have an id)
tool_req__docs_saf_attrs_mandatory		Tool Requirement

Safety Analysis Mitigation Attribute		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: NO parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:759; src/extensions/score_metamodel/metamodel.yaml:786; src/extensions/score_metamodel/metamodel.yaml:814; src/extensions/score_metamodel/metamodel.yaml:1039; satisfies: gd_req__saf_attr_mitigated_by, gd_req__saf_attr_requirements, gd_req__saf_attr_requirements_check, gd_req__saf_attr_aou, gd_req__saf_linkage_safety, tool_req__docs_metamodel
Docs-As-Code shall enforce valid needs (status == valid) of type Safety Analysis Need Types (tool_req__docs_saf_types) to have at least one mitigated_by link to a requirement on the corresponding level. At least one of the linked requirements must have the same ASIL level or a higher one. It can be comp_req or aou_req.
tool_req__docs_saf_attrs_mitigated_by		Tool Requirement

Safety Analysis Mitigation Issue Attribute		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: YES parent_covered: NO source_code_link: src/extensions/score_metamodel/metamodel.yaml:756; src/extensions/score_metamodel/metamodel.yaml:780; src/extensions/score_metamodel/metamodel.yaml:808; src/extensions/score_metamodel/metamodel.yaml:835; satisfies: gd_req__saf_attr_mitigation_issue, tool_req__docs_metamodel
Docs-As-Code shall allow needs of type Safety Analysis Need Types (tool_req__docs_saf_types) to have a mitigation_issue attribute which links to a GitHub issue.
tool_req__docs_saf_attrs_mitigation_issue		Tool Requirement

Safety Analysis Sufficient Attribute		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: YES parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:747; src/extensions/score_metamodel/metamodel.yaml:774; src/extensions/score_metamodel/metamodel.yaml:802; src/extensions/score_metamodel/metamodel.yaml:829; satisfies: gd_req__saf_attr_sufficient, tool_req__docs_metamodel
Docs-As-Code shall enforce needs of type Safety Analysis Need Types (tool_req__docs_saf_types) to have a sufficient attribute , which can have one of the following values: yes no
tool_req__docs_saf_attrs_sufficient		Tool Requirement

Safety Analysis Sufficient Check		status: valid security: NO safety: ASIL_B
tags: Safety Analysis implemented: NO parent_covered: YES satisfies: gd_req__saf_attr_sufficient
Docs-As-Code shall ensure needs of type Safety Analysis Need Types (tool_req__docs_saf_types) with sufficient == yes have a mitigated_by entry.
tool_req__docs_saf_attrs_sufficient_check		Tool Requirement

Safety Analysis Mandatory Content		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: NO parent_covered: NO source_code_link: src/extensions/score_metamodel/metamodel.yaml:750; src/extensions/score_metamodel/metamodel.yaml:777; src/extensions/score_metamodel/metamodel.yaml:805; src/extensions/score_metamodel/metamodel.yaml:832; satisfies: gd_req__saf_argument, tool_req__docs_metamodel
Docs-As-Code shall enforce needs of type Safety Analysis Need Types (tool_req__docs_saf_types) to have a non empty content.
tool_req__docs_saf_attrs_content		Tool Requirement

Safety Analysis Linkage Violates		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: NO parent_covered: YES source_code_link: src/extensions/score_metamodel/metamodel.yaml:753; src/extensions/score_metamodel/metamodel.yaml:783; src/extensions/score_metamodel/metamodel.yaml:811; src/extensions/score_metamodel/metamodel.yaml:838; satisfies: gd_req__saf_linkage_check, gd_req__saf_linkage, tool_req__docs_metamodel
Docs-As-Code shall enforce that needs of type Safety Analysis Need Types (tool_req__docs_saf_types) have a violates links to at least one dynamic / static diagram according to the table. Source | Target | – | – | feat_saf_dfa | feat_arc_sta | comp_saf_dfa | comp_arc_sta | feat_saf_fmea | feat_arc_dyn | comp_saf_fmea | comp_arc_dyn |
tool_req__docs_saf_attrs_violates		Tool Requirement

FMEA: fault id attribute		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: NO parent_covered: NO source_code_link: src/extensions/score_metamodel/metamodel.yaml:799; src/extensions/score_metamodel/metamodel.yaml:826; satisfies: gd_req__saf_attr_fault_id, tool_req__docs_metamodel
Docs-As-Code shall enforce that needs of type DFA (see Safety Analysis Need Types (tool_req__docs_saf_types)) have a fault_id attribute. Allowed values are listed as ID in tables at gd_guidl__dfa_failure_initiators.
tool_req__docs_saf_attr_fmea_fault_id		Tool Requirement

DFA: failure id attribute		status: valid security: NO safety: ASIL_B
tags: Safety Analysis, config implemented: NO parent_covered: NO source_code_link: src/extensions/score_metamodel/metamodel.yaml:744; src/extensions/score_metamodel/metamodel.yaml:771; satisfies: gd_req__saf_attr_failure_id, tool_req__docs_metamodel
Docs-As-Code shall enforce that needs of type DFA (see Safety Analysis Need Types (tool_req__docs_saf_types)) have a fault_id attribute. Allowed values are listed as ID in tables at gd_guidl__dfa_failure_initiators.
tool_req__docs_saf_attr_dfa_failure_id		Tool Requirement

Failure Effect		status: invalid security: NO safety: ASIL_B
tags: Safety Analysis implemented: NO parent_covered: NO satisfies: gd_req__saf_attr_feffect
Docs-As-Code shall enforce that every Safety Analysis has a short description of the failure effect (e.g. failure lead to an unintended actuation of the analysed element)
tool_req__docs_saf_attr_fmea_failure_effect		Tool Requirement

Mapping

ID	tool_req
gd_req__saf_argument	tool_req__docs_saf_attrs_content
gd_req__saf_attr_aou	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_failure_id	tool_req__docs_saf_attr_dfa_failure_id
gd_req__saf_attr_fault_id	tool_req__docs_saf_attr_fmea_fault_id
gd_req__saf_attr_feffect	tool_req__docs_saf_attr_fmea_failure_effect
gd_req__saf_attr_mandatory	tool_req__docs_saf_attrs_mandatory
gd_req__saf_attr_mitigated_by	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_mitigation_issue	tool_req__docs_saf_attrs_mitigation_issue
gd_req__saf_attr_requirements	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_requirements_check	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_status	tool_req__docs_common_attr_status
gd_req__saf_attr_sufficient	tool_req__docs_saf_attrs_sufficient_check; tool_req__docs_saf_attrs_sufficient
gd_req__saf_attr_title	tool_req__docs_common_attr_title
gd_req__saf_attr_uid	tool_req__docs_common_attr_id; tool_req__docs_saf_types; tool_req__docs_common_attr_id_scheme
gd_req__saf_attr_ver
gd_req__saf_finalization_check
gd_req__saf_linkage	tool_req__docs_saf_attrs_violates
gd_req__saf_linkage_check	tool_req__docs_saf_attrs_violates
gd_req__saf_linkage_safety	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_linkage_status_check
gd_req__saf_structure	tool_req__docs_saf_types
gd_req__safety_doc_status
gd_req__safety_wp_status

🗺️ Full Mapping

Process to tools:

ID	tool_req
gd_req__arch_attr_fulfils	tool_req__docs_arch_link_fulfils; tool_req__docs_arch_attr_mandatory
gd_req__arch_attr_mandatory	tool_req__docs_arch_attr_mandatory
gd_req__arch_attr_safety	tool_req__docs_common_attr_safety
gd_req__arch_attr_security	tool_req__docs_common_attr_security
gd_req__arch_attr_status	tool_req__docs_common_attr_status
gd_req__arch_attribute_uid	tool_req__docs_common_attr_id; tool_req__docs_common_attr_id_scheme
gd_req__arch_build_blocks	tool_req__docs_arch_types
gd_req__arch_build_blocks_corr
gd_req__arch_consistency_dynamic
gd_req__arch_consistency_interf
gd_req__arch_consistency_model
gd_req__arch_hierarchical_structure	tool_req__docs_arch_types
gd_req__arch_linkage_requirement	tool_req__docs_arch_link_safety_to_req; tool_req__docs_arch_link_qm_to_safety_req
gd_req__arch_linkage_requirement_type	tool_req__docs_arch_link_fulfils
gd_req__arch_linkage_safety
gd_req__arch_linkage_safety_trace	tool_req__docs_req_arch_link_safety_to_arch
gd_req__arch_linkage_security_trace	tool_req__docs_arch_link_security
gd_req__arch_model
gd_req__arch_traceability	tool_req__docs_arch_link_fulfils
gd_req__arch_viewpoints	tool_req__docs_arch_views
gd_req__change_attr_affected_wp
gd_req__change_attr_impact_description
gd_req__change_attr_impact_safety	tool_req__docs_doc_generic_mandatory
gd_req__change_attr_impact_security
gd_req__change_attr_mandatory
gd_req__change_attr_milestone
gd_req__change_attr_status
gd_req__change_attr_title	tool_req__docs_doc_attr
gd_req__change_attr_types
gd_req__change_attr_uid
gd_req__change_tool_impact_analysis
gd_req__config_baseline_diff
gd_req__config_pull_request_storage
gd_req__config_workproducts_storage
gd_req__configuration_uid
gd_req__doc_approver	tool_req__docs_doc_attr_approver_autofill; tool_req__docs_doc_attr
gd_req__doc_attributes_manual	tool_req__docs_doc_generic_mandatory
gd_req__doc_author	tool_req__docs_doc_attr_author_autofill; tool_req__docs_doc_attr
gd_req__doc_reviewer	tool_req__docs_doc_attr_reviewer_autofill; tool_req__docs_doc_attr
gd_req__doc_types	tool_req__docs_doc_types
gd_req__general_architecture_version
gd_req__general_checklist_templates
gd_req__general_requirements_version
gd_req__general_status_reset_check
gd_req__general_status_set_check
gd_req__impl_dependency_analysis
gd_req__impl_design_code_link	tool_req__docs_dd_link_source_code_link
gd_req__impl_dynamic_diagram	tool_req__docs_dd_dyn
gd_req__impl_static_diagram	tool_req__docs_dd_sta
gd_req__problem_attr_anaylsis_results
gd_req__problem_attr_classification
gd_req__problem_attr_impact_description
gd_req__problem_attr_milestone
gd_req__problem_attr_safety_affected
gd_req__problem_attr_security_affected
gd_req__problem_attr_stakeholder
gd_req__problem_attr_status
gd_req__problem_attr_title
gd_req__problem_attr_uid
gd_req__problem_check_closing
gd_req__problem_check_mandatory
gd_req__process_management_build_blocks
gd_req__process_management_build_blocks_attr	tool_req__docs_wf_types
gd_req__process_management_build_blocks_check
gd_req__process_management_build_blocks_link	tool_req__docs_wf_types
gd_req__quality_report
gd_req__release_note
gd_req__req_attr_description	tool_req__docs_common_attr_description
gd_req__req_attr_impl	tool_req__docs_dd_link_source_code_link
gd_req__req_attr_rationale	tool_req__docs_req_attr_rationale
gd_req__req_attr_req_cov	tool_req__docs_req_attr_reqcov
gd_req__req_attr_safety	tool_req__docs_common_attr_safety
gd_req__req_attr_security	tool_req__docs_common_attr_security
gd_req__req_attr_status	tool_req__docs_common_attr_status
gd_req__req_attr_test_covered	tool_req__docs_req_attr_testcov
gd_req__req_attr_testlink	tool_req__docs_test_link_testcase
gd_req__req_attr_title	tool_req__docs_common_attr_title
gd_req__req_attr_type	tool_req__docs_req_attr_reqtype
gd_req__req_attr_uid	tool_req__docs_common_attr_id; tool_req__docs_common_attr_id_scheme
gd_req__req_attr_valid_from
gd_req__req_attr_valid_until
gd_req__req_attr_version	tool_req__docs_common_attr_version
gd_req__req_check_mandatory	tool_req__docs_common_attr_description; tool_req__docs_common_attr_status; tool_req__docs_common_attr_safety; tool_req__docs_req_attr_rationale; tool_req__docs_common_attr_security; tool_req__docs_common_attr_id_scheme
gd_req__req_desc_weak	tool_req__docs_common_attr_desc_wording
gd_req__req_linkage	tool_req__docs_req_link_satisfies_allowed
gd_req__req_linkage_architecture
gd_req__req_linkage_architecture_switch	tool_req__docs_dd_feature_flag
gd_req__req_linkage_fulfill	tool_req__docs_arch_link_fulfils
gd_req__req_linkage_safety	tool_req__docs_common_attr_safety_link_check; tool_req__docs_req_arch_link_safety_to_arch
gd_req__req_structure	tool_req__docs_req_types
gd_req__req_suspicious	tool_req__docs_common_attr_suspicious
gd_req__req_traceability	tool_req__docs_req_link_satisfies_allowed
gd_req__req_validity	tool_req__docs_req_attr_validity_correctness; tool_req__docs_req_attr_validity_consistency
gd_req__saf_argument	tool_req__docs_saf_attrs_content
gd_req__saf_attr_aou	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_failure_id	tool_req__docs_saf_attr_dfa_failure_id
gd_req__saf_attr_fault_id	tool_req__docs_saf_attr_fmea_fault_id
gd_req__saf_attr_feffect	tool_req__docs_saf_attr_fmea_failure_effect
gd_req__saf_attr_mandatory	tool_req__docs_saf_attrs_mandatory
gd_req__saf_attr_mitigated_by	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_mitigation_issue	tool_req__docs_saf_attrs_mitigation_issue
gd_req__saf_attr_requirements	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_requirements_check	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_attr_status	tool_req__docs_common_attr_status
gd_req__saf_attr_sufficient	tool_req__docs_saf_attrs_sufficient_check; tool_req__docs_saf_attrs_sufficient
gd_req__saf_attr_title	tool_req__docs_common_attr_title
gd_req__saf_attr_uid	tool_req__docs_common_attr_id; tool_req__docs_saf_types; tool_req__docs_common_attr_id_scheme
gd_req__saf_attr_ver
gd_req__saf_finalization_check
gd_req__saf_linkage	tool_req__docs_saf_attrs_violates
gd_req__saf_linkage_check	tool_req__docs_saf_attrs_violates
gd_req__saf_linkage_safety	tool_req__docs_saf_attrs_mitigated_by
gd_req__saf_linkage_status_check
gd_req__saf_structure	tool_req__docs_saf_types
gd_req__safety_doc_status
gd_req__safety_wp_status
gd_req__sec_argument
gd_req__sec_attr_aou
gd_req__sec_attr_mandatory
gd_req__sec_attr_mitigated_by
gd_req__sec_attr_mitigation_issue
gd_req__sec_attr_requirements
gd_req__sec_attr_requirements_check
gd_req__sec_attr_status
gd_req__sec_attr_stride_threat_id
gd_req__sec_attr_sufficient
gd_req__sec_attr_teffect
gd_req__sec_attr_threat_scenario_id
gd_req__sec_attr_title
gd_req__sec_attr_uid
gd_req__sec_attr_ver
gd_req__sec_finalization_check
gd_req__sec_linkage
gd_req__sec_linkage_check
gd_req__sec_linkage_security
gd_req__sec_linkage_status_check
gd_req__sec_structure
gd_req__security_doc_status
gd_req__security_wp_status
gd_req__tool_attr_safety_affected	tool_req__docs_tvr_safety
gd_req__tool_attr_security_affected	tool_req__docs_tvr_security
gd_req__tool_attr_status	tool_req__docs_tvr_status
gd_req__tool_attr_tcl	tool_req__docs_tvr_confidence_level
gd_req__tool_attr_uid	tool_req__docs_common_attr_id
gd_req__tool_attr_version	tool_req__docs_tvr_version
gd_req__tool_check_mandatory	tool_req__docs_tvr_status; tool_req__docs_tvr_safety; tool_req__docs_tvr_security
gd_req__verification_checks	tool_req__docs_test_metadata_mandatory_1; tool_req__docs_test_metadata_mandatory_2; tool_req__docs_test_metadata_link_levels
gd_req__verification_checks_extended
gd_req__verification_independence
gd_req__verification_link_tests
gd_req__verification_link_tests_cpp
gd_req__verification_link_tests_python
gd_req__verification_link_tests_rust
gd_req__verification_report_archiving
gd_req__verification_reporting

Overview of Tool to Process Requirements

Process Requirement	Tool Requirement	Implemented	Source Code Link
gd_req__arch_attr_mandatory; gd_req__arch_attr_fulfils	tool_req__docs_arch_attr_mandatory	PARTIAL	src/extensions/score_metamodel/checks/check_options.py:155
gd_req__arch_linkage_requirement_type; gd_req__arch_attr_fulfils; gd_req__arch_traceability; gd_req__req_linkage_fulfill	tool_req__docs_arch_link_fulfils	PARTIAL
gd_req__arch_linkage_requirement; tool_req__docs_metamodel	tool_req__docs_arch_link_qm_to_safety_req	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:1001
gd_req__arch_linkage_requirement	tool_req__docs_arch_link_safety_to_req	PARTIAL
gd_req__arch_linkage_security_trace; tool_req__docs_metamodel	tool_req__docs_arch_link_security	YES	src/extensions/score_metamodel/metamodel.yaml:1025
gd_req__arch_hierarchical_structure; gd_req__arch_build_blocks; tool_req__docs_metamodel	tool_req__docs_arch_types	YES	src/extensions/score_metamodel/metamodel.yaml:423; src/extensions/score_metamodel/metamodel.yaml:469; src/extensions/score_metamodel/metamodel.yaml:491; src/extensions/score_metamodel/metamodel.yaml:617; src/extensions/score_metamodel/metamodel.yaml:639
gd_req__arch_viewpoints; tool_req__docs_metamodel	tool_req__docs_arch_views	YES	src/extensions/score_metamodel/metamodel.yaml:424; src/extensions/score_metamodel/metamodel.yaml:447; src/extensions/score_metamodel/metamodel.yaml:470; src/extensions/score_metamodel/metamodel.yaml:530; src/extensions/score_metamodel/metamodel.yaml:574; src/extensions/score_metamodel/metamodel.yaml:597; src/extensions/score_metamodel/metamodel.yaml:618
gd_req__req_desc_weak; tool_req__docs_metamodel	tool_req__docs_common_attr_desc_wording	YES	src/extensions/score_metamodel/metamodel.yaml:39; src/extensions/score_metamodel/checks/attributes_format.py:109
gd_req__req_attr_description; gd_req__req_check_mandatory	tool_req__docs_common_attr_description	YES
gd_req__req_attr_uid; gd_req__tool_attr_uid; gd_req__arch_attribute_uid; gd_req__saf_attr_uid	tool_req__docs_common_attr_id	YES
gd_req__req_attr_uid; gd_req__arch_attribute_uid; gd_req__saf_attr_uid; gd_req__req_check_mandatory	tool_req__docs_common_attr_id_scheme	PARTIAL	src/extensions/score_metamodel/checks/attributes_format.py:30
gd_req__req_check_mandatory; gd_req__req_attr_safety; gd_req__arch_attr_safety; tool_req__docs_metamodel	tool_req__docs_common_attr_safety	YES	src/extensions/score_metamodel/metamodel.yaml:250; src/extensions/score_metamodel/metamodel.yaml:285; src/extensions/score_metamodel/metamodel.yaml:319; src/extensions/score_metamodel/metamodel.yaml:348; src/extensions/score_metamodel/metamodel.yaml:381; src/extensions/score_metamodel/metamodel.yaml:411; src/extensions/score_metamodel/metamodel.yaml:432; src/extensions/score_metamodel/metamodel.yaml:455; src/extensions/score_metamodel/metamodel.yaml:478; src/extensions/score_metamodel/metamodel.yaml:499; src/extensions/score_metamodel/metamodel.yaml:519; src/extensions/score_metamodel/metamodel.yaml:561; src/extensions/score_metamodel/metamodel.yaml:582; src/extensions/score_metamodel/metamodel.yaml:605; src/extensions/score_metamodel/metamodel.yaml:626; src/extensions/score_metamodel/metamodel.yaml:647; src/extensions/score_metamodel/checks/check_options.py:152
gd_req__req_linkage_safety; tool_req__docs_metamodel	tool_req__docs_common_attr_safety_link_check	YES	src/extensions/score_metamodel/metamodel.yaml:992
gd_req__req_attr_security; gd_req__arch_attr_security; gd_req__req_check_mandatory; tool_req__docs_metamodel	tool_req__docs_common_attr_security	YES	src/extensions/score_metamodel/metamodel.yaml:258; src/extensions/score_metamodel/metamodel.yaml:283; src/extensions/score_metamodel/metamodel.yaml:317; src/extensions/score_metamodel/metamodel.yaml:346; src/extensions/score_metamodel/metamodel.yaml:379; src/extensions/score_metamodel/metamodel.yaml:409; src/extensions/score_metamodel/metamodel.yaml:430; src/extensions/score_metamodel/metamodel.yaml:453; src/extensions/score_metamodel/metamodel.yaml:476; src/extensions/score_metamodel/metamodel.yaml:497; src/extensions/score_metamodel/metamodel.yaml:517; src/extensions/score_metamodel/metamodel.yaml:559; src/extensions/score_metamodel/metamodel.yaml:580; src/extensions/score_metamodel/metamodel.yaml:603; src/extensions/score_metamodel/metamodel.yaml:624; src/extensions/score_metamodel/metamodel.yaml:645; src/extensions/score_metamodel/checks/check_options.py:151
gd_req__req_attr_status; gd_req__arch_attr_status; gd_req__saf_attr_status; gd_req__req_check_mandatory; tool_req__docs_metamodel	tool_req__docs_common_attr_status	YES	src/extensions/score_metamodel/metamodel.yaml:125; src/extensions/score_metamodel/metamodel.yaml:252; src/extensions/score_metamodel/metamodel.yaml:287; src/extensions/score_metamodel/metamodel.yaml:321; src/extensions/score_metamodel/metamodel.yaml:350; src/extensions/score_metamodel/metamodel.yaml:383; src/extensions/score_metamodel/metamodel.yaml:413; src/extensions/score_metamodel/metamodel.yaml:434; src/extensions/score_metamodel/metamodel.yaml:457; src/extensions/score_metamodel/metamodel.yaml:480; src/extensions/score_metamodel/metamodel.yaml:501; src/extensions/score_metamodel/metamodel.yaml:521; src/extensions/score_metamodel/metamodel.yaml:563; src/extensions/score_metamodel/metamodel.yaml:584; src/extensions/score_metamodel/metamodel.yaml:607; src/extensions/score_metamodel/metamodel.yaml:628; src/extensions/score_metamodel/metamodel.yaml:649; src/extensions/score_metamodel/checks/check_options.py:153
gd_req__req_suspicious	tool_req__docs_common_attr_suspicious	NO
gd_req__req_attr_title; gd_req__saf_attr_title; tool_req__docs_metamodel	tool_req__docs_common_attr_title	YES	src/extensions/score_metamodel/metamodel.yaml:33; src/extensions/score_metamodel/checks/attributes_format.py:110
gd_req__req_attr_version	tool_req__docs_common_attr_version	NO
gd_req__impl_dynamic_diagram; tool_req__docs_metamodel	tool_req__docs_dd_dyn	YES	src/extensions/score_metamodel/metamodel.yaml:688
gd_req__req_linkage_architecture_switch	tool_req__docs_dd_feature_flag	NO
gd_req__req_attr_impl; gd_req__impl_design_code_link; tool_req__docs_metamodel	tool_req__docs_dd_link_source_code_link	YES	src/extensions/score_metamodel/metamodel.yaml:17; src/extensions/score_source_code_linker/needlinks.py:13; src/extensions/score_source_code_linker/need_source_links.py:20
gd_req__impl_static_diagram; tool_req__docs_metamodel	tool_req__docs_dd_sta	YES	src/extensions/score_metamodel/metamodel.yaml:671
gd_req__doc_author; gd_req__doc_approver; gd_req__doc_reviewer; gd_req__change_attr_title; tool_req__docs_metamodel	tool_req__docs_doc_attr	NO	src/extensions/score_metamodel/metamodel.yaml:211; src/extensions/score_metamodel/metamodel.yaml:235
gd_req__doc_approver	tool_req__docs_doc_attr_approver_autofill	NO
gd_req__doc_author	tool_req__docs_doc_attr_author_autofill	NO
gd_req__doc_reviewer	tool_req__docs_doc_attr_reviewer_autofill	NO
gd_req__doc_attributes_manual; gd_req__change_attr_impact_safety; tool_req__docs_metamodel	tool_req__docs_doc_generic_mandatory	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:205; src/extensions/score_metamodel/metamodel.yaml:215
gd_req__doc_types; tool_req__docs_metamodel	tool_req__docs_doc_types	YES	src/extensions/score_metamodel/metamodel.yaml:201; src/extensions/score_metamodel/metamodel.yaml:220
gd_req__arch_linkage_safety_trace; gd_req__req_linkage_safety; tool_req__docs_metamodel	tool_req__docs_req_arch_link_safety_to_arch	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:1010
gd_req__req_attr_rationale; gd_req__req_check_mandatory; tool_req__docs_metamodel	tool_req__docs_req_attr_rationale	YES	src/extensions/score_metamodel/metamodel.yaml:256; src/extensions/score_metamodel/checks/check_options.py:154
gd_req__req_attr_req_cov; tool_req__docs_metamodel	tool_req__docs_req_attr_reqcov	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:263; src/extensions/score_metamodel/metamodel.yaml:296; src/extensions/score_metamodel/metamodel.yaml:330; src/extensions/score_metamodel/metamodel.yaml:360; src/extensions/score_metamodel/metamodel.yaml:389
gd_req__req_attr_type; tool_req__docs_metamodel	tool_req__docs_req_attr_reqtype	YES	src/extensions/score_metamodel/metamodel.yaml:248; src/extensions/score_metamodel/metamodel.yaml:281; src/extensions/score_metamodel/metamodel.yaml:315; src/extensions/score_metamodel/metamodel.yaml:377; src/extensions/score_metamodel/checks/check_options.py:150
gd_req__req_attr_test_covered; tool_req__docs_metamodel	tool_req__docs_req_attr_testcov	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:265; src/extensions/score_metamodel/metamodel.yaml:298; src/extensions/score_metamodel/metamodel.yaml:332; src/extensions/score_metamodel/metamodel.yaml:362; src/extensions/score_metamodel/metamodel.yaml:391
gd_req__req_validity	tool_req__docs_req_attr_validity_consistency	PARTIAL	src/extensions/score_metamodel/checks/check_options.py:223
gd_req__req_validity; tool_req__docs_metamodel	tool_req__docs_req_attr_validity_correctness	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:268; src/extensions/score_metamodel/metamodel.yaml:301
gd_req__req_linkage; gd_req__req_traceability; tool_req__docs_metamodel	tool_req__docs_req_link_satisfies_allowed	PARTIAL	src/extensions/score_metamodel/metamodel.yaml:129; src/extensions/score_metamodel/metamodel.yaml:291; src/extensions/score_metamodel/metamodel.yaml:325; src/extensions/score_metamodel/metamodel.yaml:354
gd_req__req_structure; tool_req__docs_metamodel	tool_req__docs_req_types	YES	src/extensions/score_metamodel/metamodel.yaml:121; src/extensions/score_metamodel/metamodel.yaml:244; src/extensions/score_metamodel/metamodel.yaml:276; src/extensions/score_metamodel/metamodel.yaml:311; src/extensions/score_metamodel/metamodel.yaml:342; src/extensions/score_metamodel/metamodel.yaml:373
gd_req__saf_attr_failure_id; tool_req__docs_metamodel	tool_req__docs_saf_attr_dfa_failure_id	NO	src/extensions/score_metamodel/metamodel.yaml:744; src/extensions/score_metamodel/metamodel.yaml:771
gd_req__saf_attr_feffect	tool_req__docs_saf_attr_fmea_failure_effect	NO
gd_req__saf_attr_fault_id; tool_req__docs_metamodel	tool_req__docs_saf_attr_fmea_fault_id	NO	src/extensions/score_metamodel/metamodel.yaml:799; src/extensions/score_metamodel/metamodel.yaml:826
gd_req__saf_argument; tool_req__docs_metamodel	tool_req__docs_saf_attrs_content	NO	src/extensions/score_metamodel/metamodel.yaml:750; src/extensions/score_metamodel/metamodel.yaml:777; src/extensions/score_metamodel/metamodel.yaml:805; src/extensions/score_metamodel/metamodel.yaml:832
gd_req__saf_attr_mandatory	tool_req__docs_saf_attrs_mandatory	YES
gd_req__saf_attr_mitigated_by; gd_req__saf_attr_requirements; gd_req__saf_attr_requirements_check; gd_req__saf_attr_aou; gd_req__saf_linkage_safety; tool_req__docs_metamodel	tool_req__docs_saf_attrs_mitigated_by	NO	src/extensions/score_metamodel/metamodel.yaml:759; src/extensions/score_metamodel/metamodel.yaml:786; src/extensions/score_metamodel/metamodel.yaml:814; src/extensions/score_metamodel/metamodel.yaml:1039
gd_req__saf_attr_mitigation_issue; tool_req__docs_metamodel	tool_req__docs_saf_attrs_mitigation_issue	YES	src/extensions/score_metamodel/metamodel.yaml:756; src/extensions/score_metamodel/metamodel.yaml:780; src/extensions/score_metamodel/metamodel.yaml:808; src/extensions/score_metamodel/metamodel.yaml:835
gd_req__saf_attr_sufficient; tool_req__docs_metamodel	tool_req__docs_saf_attrs_sufficient	YES	src/extensions/score_metamodel/metamodel.yaml:747; src/extensions/score_metamodel/metamodel.yaml:774; src/extensions/score_metamodel/metamodel.yaml:802; src/extensions/score_metamodel/metamodel.yaml:829
gd_req__saf_attr_sufficient	tool_req__docs_saf_attrs_sufficient_check	NO
gd_req__saf_linkage_check; gd_req__saf_linkage; tool_req__docs_metamodel	tool_req__docs_saf_attrs_violates	NO	src/extensions/score_metamodel/metamodel.yaml:753; src/extensions/score_metamodel/metamodel.yaml:783; src/extensions/score_metamodel/metamodel.yaml:811; src/extensions/score_metamodel/metamodel.yaml:838
gd_req__saf_structure; gd_req__saf_attr_uid; tool_req__docs_metamodel	tool_req__docs_saf_types	YES	src/extensions/score_metamodel/metamodel.yaml:740; src/extensions/score_metamodel/metamodel.yaml:767; src/extensions/score_metamodel/metamodel.yaml:795; src/extensions/score_metamodel/metamodel.yaml:822
gd_req__req_attr_testlink	tool_req__docs_test_link_testcase	PARTIAL	src/extensions/score_source_code_linker/testlink.py:21; src/extensions/score_source_code_linker/xml_parser.py:19; src/extensions/score_source_code_linker/need_source_links.py:19
gd_req__verification_checks	tool_req__docs_test_metadata_link_levels	NO
gd_req__verification_checks	tool_req__docs_test_metadata_mandatory_1	NO
gd_req__verification_checks	tool_req__docs_test_metadata_mandatory_2	NO
gd_req__tool_attr_tcl; tool_req__docs_metamodel	tool_req__docs_tvr_confidence_level	YES	src/extensions/score_metamodel/metamodel.yaml:232
gd_req__tool_attr_safety_affected; gd_req__tool_check_mandatory; tool_req__docs_metamodel	tool_req__docs_tvr_safety	YES	src/extensions/score_metamodel/metamodel.yaml:228
gd_req__tool_attr_security_affected; gd_req__tool_check_mandatory; tool_req__docs_metamodel	tool_req__docs_tvr_security	YES	src/extensions/score_metamodel/metamodel.yaml:230
gd_req__tool_attr_status; gd_req__tool_check_mandatory; tool_req__docs_metamodel	tool_req__docs_tvr_status	YES	src/extensions/score_metamodel/metamodel.yaml:224
gd_req__tool_attr_version; tool_req__docs_metamodel	tool_req__docs_tvr_version	YES	src/extensions/score_metamodel/metamodel.yaml:226
gd_req__process_management_build_blocks_attr; gd_req__process_management_build_blocks_link; tool_req__docs_metamodel	tool_req__docs_wf_types	YES	src/extensions/score_metamodel/metamodel.yaml:104

Grouped Requirements

Metamodel		status: valid security: NO safety: ASIL_B
tags: metamodel implemented: YES satisfied by: tool_req__docs_dd_link_source_code_link, tool_req__docs_common_attr_title, tool_req__docs_common_attr_desc_wording, tool_req__docs_stdreq_types, tool_req__docs_wf_types, tool_req__docs_req_types, tool_req__docs_common_attr_status, tool_req__docs_req_link_satisfies_allowed, tool_req__docs_doc_types, tool_req__docs_doc_generic_mandatory, tool_req__docs_doc_attr, tool_req__docs_tvr_status, tool_req__docs_tvr_version, tool_req__docs_tvr_safety, tool_req__docs_tvr_security, tool_req__docs_tvr_confidence_level, tool_req__docs_req_attr_reqtype, tool_req__docs_common_attr_safety, tool_req__docs_req_attr_rationale, tool_req__docs_common_attr_security, tool_req__docs_req_attr_reqcov, tool_req__docs_req_attr_testcov, tool_req__docs_req_attr_validity_correctness, tool_req__docs_arch_types, tool_req__docs_arch_views, tool_req__docs_dd_sta, tool_req__docs_dd_dyn, tool_req__docs_saf_types, tool_req__docs_saf_attr_dfa_failure_id, tool_req__docs_saf_attrs_sufficient, tool_req__docs_saf_attrs_content, tool_req__docs_saf_attrs_violates, tool_req__docs_saf_attrs_mitigation_issue, tool_req__docs_saf_attrs_mitigated_by, tool_req__docs_saf_attr_fmea_fault_id, tool_req__docs_common_attr_safety_link_check, tool_req__docs_arch_link_qm_to_safety_req, tool_req__docs_req_arch_link_safety_to_arch, tool_req__docs_arch_link_security
Docs-as-Code shall provide a metamodel for definining config in a metamodel.yaml in the source code repository. Note “satisfied by” is something like “used by” or “required by”.
tool_req__docs_metamodel		Tool Requirement