[Your Component Name]#

Note

Document header

[Your Component Name]
status: draft
security: NO
safety: ASIL_B
tags: template
version: 1
Component Name
status: valid
security: YES
safety: ASIL_B
bazel_target: @@//score/component_example:component_example
bazel_type: cc_library
version: 1
coverage: lines no data · branches no data · files 0/2

Attention

The above directives must be updated according to your Component.

  • Modify document to be your Component Name

  • Modify id to be your Component Name in lower snake case preceded by doc__

  • Adjust status to be valid

  • Adjust safety, security and tags according to your needs

  • Take the comp directive out of the code block and adapt it to your Component

  • The implements, uses, consists_of and fulfils links on comp are optional; include them when applicable

Note

This document is the Component Request (CR) of the component. It describes the current state of the component. Content that belongs to a change of the component, like rationale, rejected ideas, open issues and the impact on safety, security and license, is documented in a Decision Record (gd_temp__change_decision_record) and, if needed, in an Impact Analysis (gd_temp__change_impact_analysis).

Abstract#

[A short (~200 word) description of the component.]

Motivation#

[Explain why the component is needed: which features or stakeholder needs it serves and why existing components are not sufficient.]

Specification#

[Describe the requirements and architecture of the component. Details are documented in the documents listed in Component Detail Information.]

How to Teach This#

[How to teach users, new and experienced, how to apply the CR to their work.]

Note

For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.

Footnotes#

[A collection of footnotes cited in the CR, and a place to list non-inline hyperlink targets.]

Component Detail Information#

Further documentation of the component can be found in the following documents:

Note

The documents listed below describe this component. Create separate architecture, safety-analysis, and security-analysis documents for subcomponents only when this component is decomposed into subcomponents and those artifacts apply.