Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Differentiation between Decision Records (DR) and Standards #352

Closed
cah-hbaum opened this issue Sep 29, 2023 · 4 comments · Fixed by #441
Closed

Differentiation between Decision Records (DR) and Standards #352

cah-hbaum opened this issue Sep 29, 2023 · 4 comments · Fixed by #441
Assignees
Labels
SCS is standardized SCS is standardized SCS-VP10 Related to tender lot SCS-VP10 standards Issues / ADR / pull requests relevant for standardization & certification

Comments

@cah-hbaum
Copy link
Contributor

During a meeting between Cloud&Heat and SecuStack, we had a short in discussion about the naming standard for Decision Records and Standards. Both document types are placed in the same location and their names are derived from the same naming scheme, which in our opinion leads to the following problems:

  • DRs and Standards share a version numbering, which means that a standard could start at v2 (or even later) just because a DR was already created with/about the same topic. This could happen quite often, since DR often prepare and predate a Standard.
  • The numbering could even become more confusing, if a new Standard version should be created and a DR is created beforehand again.
  • To mitigate this with the current standardization, a Standard would need to have a different name as the DR. If this is the case, the documents could not be immediately seen as references to one another and the standard folder would be filled up with many documents that don't contain standards and are therefore not binding.

In our opinion, this should be changed in order to be more clear about the difference of Decision Records and Standards and therefore make the versioning more clear.

This issue should be seen as a ground for discussion and perhaps a way to change the Standardization-Standard in the end.

@cah-hbaum cah-hbaum added standards Issues / ADR / pull requests relevant for standardization & certification SCS is standardized SCS is standardized SCS-VP10 Related to tender lot SCS-VP10 labels Sep 29, 2023
@cah-hbaum cah-hbaum self-assigned this Sep 29, 2023
@markus-hentsch
Copy link
Contributor

markus-hentsch commented Sep 29, 2023

My two cents:

  • the versioning part (-vN-) in the scs-XXXX-vN-template.md naming scheme is primarily relevant for actual standards since those are versioned and supersede one another
  • when maintaining the DRs as separate files alongside the standards, splitting up the DR in multiple dedicated and versioned files over time does not make much sense; it would be better to keep exactly one (unversioned) DR file per standard that is maintained alongside the evolving standard versions
    • an alternative option would be to include the DR into the standards themselves as an appendix subsection
  • regardless of where to put the DR (subsection in standard vs. dedicated file), the current scs-XXXX-vN-template.md template is a bad fit for decision records as it is primarily designed for standards, I'd expect a dedicated DR template file or section that specifies the DR structure and mandatory DR entry fields, like:
    • decision date
    • decision maker
    • decision
    • reasoning / rationale
    • etc.

@cah-hbaum
Copy link
Contributor Author

cah-hbaum commented Oct 4, 2023

I agree with these two cents.

We will probably bring this issue up in the next "SIG Standardization/Certification" meeting.

@fkr
Copy link
Member

fkr commented Oct 4, 2023

Thanks @markus-hentsch and @cah-hbaum - just as the standards themselves are developed in a community driven process, so should also be the format and outline of decisions records.
We did unify the location a while ago (there used to be a standards and a decision folder) and this was discussed at length. However from my perspective that is just one of the minor points being addressed here - one of the major items (and @markus-hentsch points that out in this last bullet point) could and should be addressed. I would very much welcome a suggestion for such a template.

cah-hbaum added a commit that referenced this issue Jan 5, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
@cah-hbaum cah-hbaum moved this from Backlog to Doing in Sovereign Cloud Stack Jan 5, 2024
@cah-hbaum
Copy link
Contributor Author

I created PR #441, where the discussion can be continued and expanded.
I also made a first suggestion for a new template there and also updated the old standard template.

cah-hbaum added a commit that referenced this issue Jan 5, 2024
cah-hbaum added a commit that referenced this issue Jan 8, 2024
cah-hbaum added a commit that referenced this issue Jan 17, 2024
cah-hbaum added a commit that referenced this issue Jan 17, 2024
Updated the test to allow both templates to exist site by site.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 19, 2024
Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 19, 2024
cah-hbaum added a commit that referenced this issue Jan 24, 2024
cah-hbaum added a commit that referenced this issue Jan 24, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 24, 2024
Updated the test to allow both templates to exist site by site.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 24, 2024
Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 24, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 24, 2024
Updated the test to allow both templates to exist site by site.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 24, 2024
Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Jan 25, 2024
cah-hbaum added a commit that referenced this issue Jan 25, 2024
cah-hbaum added a commit that referenced this issue Jan 30, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Feb 14, 2024
Rewrite some of the documents slightly to fit the structure of the standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 7, 2024
cah-hbaum added a commit that referenced this issue Mar 7, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 7, 2024
Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 7, 2024
Rewrite some of the documents slightly to fit the structure of the standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 7, 2024
Include some cosmetic and grammar changes. More overall work is done in another PR.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 7, 2024
Added some suggestions made by @anjastrunk.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 11, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 11, 2024
Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 11, 2024
Rewrite some of the documents slightly to fit the structure of the standard.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 18, 2024
cah-hbaum added a commit that referenced this issue Mar 18, 2024
Removes the introduction section from the DR as I evaluated with @markus.hentsch.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Mar 18, 2024
cah-hbaum added a commit that referenced this issue Mar 21, 2024
Like discussed in the SIG Standardization and Certification Meeting, an Abstract section is introduced to the DR documents.

Signed-off-by: Hannes Baum <[email protected]>
cah-hbaum added a commit that referenced this issue Apr 3, 2024
@anjastrunk anjastrunk mentioned this issue Apr 15, 2024
59 tasks
cah-hbaum added a commit that referenced this issue Apr 16, 2024
This reverts commit 506a85d.

Signed-off-by: Hannes Baum <[email protected]>
fkr pushed a commit that referenced this issue Apr 16, 2024
Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>
fkr pushed a commit that referenced this issue Apr 16, 2024
Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>
fkr pushed a commit that referenced this issue Apr 16, 2024
Rewrite some of the documents slightly to fit the structure of the standard.

Signed-off-by: Hannes Baum <[email protected]>
fkr pushed a commit that referenced this issue Apr 16, 2024
fkr pushed a commit that referenced this issue Apr 16, 2024
Removes the introduction section from the DR as I evaluated with @markus.hentsch.

Signed-off-by: Hannes Baum <[email protected]>
fkr pushed a commit that referenced this issue Apr 16, 2024
fkr pushed a commit that referenced this issue Apr 16, 2024
Like discussed in the SIG Standardization and Certification Meeting, an Abstract section is introduced to the DR documents.

Signed-off-by: Hannes Baum <[email protected]>
fkr pushed a commit that referenced this issue Apr 16, 2024
This reverts commit 506a85d.

Signed-off-by: Hannes Baum <[email protected]>
@fkr fkr closed this as completed in #441 Apr 16, 2024
fkr pushed a commit that referenced this issue Apr 16, 2024
* Differentiation between standards and decision records (#352)

Adds a template for decision records and updates the template for standards, since both document types are different from each other.

Signed-off-by: Hannes Baum <[email protected]>

* Update standard to include DR (#352)

Update the relevant standard to differentiate DR and Standard.

Signed-off-by: Hannes Baum <[email protected]>

* Examples for documents (#352)

Rewrite some of the documents slightly to fit the structure of the standard.

Signed-off-by: Hannes Baum <[email protected]>

* fixup! Update standard to include DR (#352)

Signed-off-by: Hannes Baum <[email protected]>

* Remove introduction section (#352)

Removes the introduction section from the DR as I evaluated with @markus.hentsch.

Signed-off-by: Hannes Baum <[email protected]>

* fixup! Remove introduction section (#352)

Signed-off-by: Hannes Baum <[email protected]>

* Add Abstract section (#352)

Like discussed in the SIG Standardization and Certification Meeting, an Abstract section is introduced to the DR documents.

Signed-off-by: Hannes Baum <[email protected]>

* Revert "Examples for documents (#352)"

This reverts commit 506a85d.

Signed-off-by: Hannes Baum <[email protected]>

* Small updates

Small updates based on the changes requested by @mbuechse.

Signed-off-by: Hannes Baum <[email protected]>

---------

Signed-off-by: Hannes Baum <[email protected]>
@github-project-automation github-project-automation bot moved this from Doing to Done in Sovereign Cloud Stack Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SCS is standardized SCS is standardized SCS-VP10 Related to tender lot SCS-VP10 standards Issues / ADR / pull requests relevant for standardization & certification
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants