Improved links to MADR, added one template #62
Conversation
|
Thanks! I see the PR has a different things mixed together. For the new info, that's good. Would you like to do a PR for just that, so you get credit for it? Or if you prefer I can just add it on my side. For the MADR-related items, those aren't OK as is. MADR is the author's abbreviation, and the related tool name is "madr", and the GitHub link uses "madr". This repo's links and template are using "MADR" in order to match the author's abbreviation. The author and I have been in touch for many years, and MADR is what the MADR author requested of me. If the author wants a change, I'll of course do it. |
README.md
Outdated
| * [Decision record template for MADR](templates/decision-record-template-madr/index.md) | ||
| * [Decision record template in Markdown](templates/decision-record-template-madr/index.md) |
There was a problem hiding this comment.
Had a discussion with @socadk:
How about "Decision record template of the MADR project"?
README.md
Outdated
| @@ -231,7 +232,7 @@ ADR example templates that we have collected on the net: | |||
|
|
|||
| * [ADR template for business case](templates/decision-record-template-for-business-case/index.md) (more MBA-oriented, with costs, SWOT, and more opinions) | |||
|
|
|||
| * [ADR template MADR](templates/decision-record-template-madr/index.md) (more Markdown) | |||
| * [ADR template MADR](templates/decision-record-template-madr/index.md) (Markdown Any/Architectural Decision Records) | |||
There was a problem hiding this comment.
Our proposal:
[ADR template Markdown Any Decision Records (MADR)](templates/decision-record-template-madr/index.md) (both simple and elaborate version; the latter emphasizes options and their pros and cons)
|
Thanks for the feedback to both of you, I have changed the patch-1 branch accordingly. I can also create a new separate PR if that helps. The README also has a section "Suggestions for writing good ADRs", I recently wrote on this topic here: https://ozimmer.ch/practices/2023/04/03/ADRCreation.html (just FYI, comments welcome). |
|
Good thanks! |
No description provided.