Skip to content

Putting decision contents into the sphinx elements bloats the needs model #204

@NEOatNHNG

Description

@NEOatNHNG

The decision record element is supposed to contain attributes for the context, decision, and consequences:

:context: <Your text>
:decision: <Your text>
:consequences: <Your text>

But that has a few problems:

  1. There is a regex for the attribute restricting it to one line. That is impractical for any serious decision.
  2. It bloats the needs model with all the contents which are not necessary to be used from anywhere else in a structured manner.

Therefore my proposal would be:

  1. Instead of having an attribute for the decision, just make say that the content of the element contains the decision
  2. Context, Considered Alternatives, etc. should be contained in the context surrounding the needs element.

That way the decision and where it applies to, status, etc. is still available as structured information but when you want to know how it came to the decision you can just click on the ID so that you jump to the page containing the decision and can read all the background there.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions