-
Notifications
You must be signed in to change notification settings - Fork 10
Closed
Copy link
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
The decision record element is supposed to contain attributes for the context, decision, and consequences:
Lines 37 to 39 in 0ac7c3b
| :context: <Your text> | |
| :decision: <Your text> | |
| :consequences: <Your text> |
But that has a few problems:
- There is a regex for the attribute restricting it to one line. That is impractical for any serious decision.
- 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:
- Instead of having an attribute for the decision, just make say that the content of the element contains the decision
- 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 documentationImprovements or additions to documentation
Type
Projects
Status
Done