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
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
..
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _decision_record_template:

Decision Record Template
========================

This template is used to create new Decision Records (DRs) in the project using rst files.
For markdown files, please convert the sphinx directive to markdown syntax yourself.
The content of the DR is the same, only the syntax differs.

Suggest to store close to the artefact which is affected by the DR. For example for
platform wide decisions store close to the platform's stakeholder requirements.

In each DR file, include the following sections:

.. code-block:: rst

.. dec_rec:: <Title>
:id: dec_rec__<Platform|Feature|Component>__<Title>
:status: <proposed|accepted|deprecated|rejected|superseded>
:version: 1
:affects: <link>

<Description>
Descriptions shall contain at least the following sections:
Context: <Your text>
Decision: <Your text>
Consequences: <Your text>

or use the the provided template below (if not marked as optional, it is mandatory content):

<Decision>

Context
-------
<your text, diagrams, etc>

Consequences
------------
<your text, diagrams, etc>

(optional)
[
Alternatives Considered
-----------------------

<Alternative A>
^^^^^^^^^^^^^^^
<description of the alternative>

Advantages
""""""""""
* **<Advantage 1>:** <Explanation>
* **<Advantage 2>:** <Explanation>

Disadvantages
"""""""""""""
* **<Disadvantage 1>:** <Explanation>
* **<Disadvantage 2>:** <Explanation>
]

Justification for the Decision
------------------------------
<your text>

.. attention::
The above directive must be updated according to your decision record.

- Modify ``dec_rec`` to provide a descriptive and concise title. Summarizing the decision. (mandatory)
- Modify ``id`` to contain the Platform/Feature/Component name the DR belongs to and the title, in upper snake case preceded by ``dec_rec__`` (mandatory)
- Adjust ``status`` according to your needs (mandatory)
- Modify ``affects`` to point to the work product it affects, mostly this will be requirements, architecture or design (recommended)
- Provide ``Description`` (mandatory)
- Add ``Context`` to describe the issue or motivation behind this decision or change (mandatory)
- Add ``decision`` to detail the proposed change or decision (mandatory)
- Add ``consequences`` to explain the impact of this change, including what becomes easier or more difficult (recommended)
1 change: 1 addition & 0 deletions process/folder_templates/platform/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Platform
features/index.rst
requirements/stakeholder/chklst_req_inspection.rst
requirements/stakeholder/index.rst
docs/change/decision_record.rst
docs/release/release_note.rst
docs/safety_mgt/index.rst
docs/security_mgt/index.rst
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,70 +23,4 @@ Decision Record Template
:version: 1
:complies: std_req__aspice_40__SWE-2-BP3[version==1], std_req__aspice_40__iic-17-00[version==1]

This template is used to create new Decision Records (DRs) in the project.

Suggest to store close to the artefact which is affected by the DR. For example for platform wide decisions store close to the platform's stakeholder requirements.

In each DR file, include the following sections:

.. code-block:: rst

.. dec_rec:: <Title>
:id: dec_rec__<Platform|Feature|Component>__<Title>
:status: <proposed|accepted|deprecated|rejected|superseded>
:version: 1
:affects: <link>

<Description>
Descriptions shall contain at least the following sections:
Context: <Your text>
Decision: <Your text>
Consequences: <Your text>

or use the the provided template below (if not marked as optional, it is mandatory content):

<Decision>

Context
-------
<your text, diagrams, etc>

Consequences
------------
<your text, diagrams, etc>

(optional)
[
Alternatives Considered
-----------------------

<Alternative A>
^^^^^^^^^^^^^^^
<description of the alternative>

Advantages
""""""""""
* **<Advantage 1>:** <Explanation>
* **<Advantage 2>:** <Explanation>

Disadvantages
"""""""""""""
* **<Disadvantage 1>:** <Explanation>
* **<Disadvantage 2>:** <Explanation>
]

Justification for the Decision
------------------------------
<your text>

.. attention::
The above directive must be updated according to your decision record.

- Modify ``dec_rec`` to provide a descriptive and concise title. Summarizing the decision. (mandatory)
- Modify ``id`` to contain the Platform/Feature/Component name the DR belongs to and the title, in upper snake case preceded by ``dec_rec__`` (mandatory)
- Adjust ``status`` according to your needs (mandatory)
- Modify ``affects`` to point to the work product it affects, mostly this will be requirements, architecture or design (recommended)
- Provide ``Description`` (mandatory)
- Add ``Context`` to describe the issue or motivation behind this decision or change (mandatory)
- Add ``decision`` to detail the proposed change or decision (mandatory)
- Add ``consequences`` to explain the impact of this change, including what becomes easier or more difficult (recommended)
For the content see here: :ref:`decision_record_template`.
Loading