| <!DOCTYPE html> |
| <html lang="en-US"> |
| <head> |
| <style> |
| .highlight table td{padding:5px}.highlight table pre{margin:0}.highlight .cm{color:#777772;font-style:italic}.highlight .cp{color:#797676;font-weight:bold}.highlight .c1{color:#777772;font-style:italic}.highlight .cs{color:#797676;font-weight:bold;font-style:italic}.highlight .c,.highlight .cd{color:#777772;font-style:italic}.highlight .err{color:#a61717;background-color:#e3d2d2}.highlight .gd{color:#000000;background-color:#ffdddd}.highlight .ge{color:#000000;font-style:italic}.highlight .gr{color:#aa0000}.highlight .gh{color:#797676}.highlight .gi{color:#000000;background-color:#ddffdd}.highlight .go{color:#888888}.highlight .gp{color:#555555}.highlight .gs{font-weight:bold}.highlight .gu{color:#aaaaaa}.highlight .gt{color:#aa0000}.highlight .kc{color:#000000;font-weight:bold}.highlight .kd{color:#000000;font-weight:bold}.highlight .kn{color:#000000;font-weight:bold}.highlight .kp{color:#000000;font-weight:bold}.highlight .kr{color:#000000;font-weight:bold}.highlight .kt{color:#445588;font-weight:bold}.highlight .k,.highlight .kv{color:#000000;font-weight:bold}.highlight .mf{color:#009999}.highlight .mh{color:#009999}.highlight .il{color:#009999}.highlight .mi{color:#009999}.highlight .mo{color:#009999}.highlight .m,.highlight .mb,.highlight .mx{color:#009999}.highlight .sb{color:#d14}.highlight .sc{color:#d14}.highlight .sd{color:#d14}.highlight .s2{color:#d14}.highlight .se{color:#d14}.highlight .sh{color:#d14}.highlight .si{color:#d14}.highlight .sx{color:#d14}.highlight .sr{color:#009926}.highlight .s1{color:#d14}.highlight .ss{color:#990073}.highlight .s{color:#d14}.highlight .na{color:#008080}.highlight .bp{color:#797676}.highlight .nb{color:#0086B3}.highlight .nc{color:#445588;font-weight:bold}.highlight .no{color:#008080}.highlight .nd{color:#3c5d5d;font-weight:bold}.highlight .ni{color:#800080}.highlight .ne{color:#990000;font-weight:bold}.highlight .nf{color:#990000;font-weight:bold}.highlight .nl{color:#990000;font-weight:bold}.highlight .nn{color:#555555}.highlight .nt{color:#000080}.highlight .vc{color:#008080}.highlight .vg{color:#008080}.highlight .vi{color:#008080}.highlight .nv{color:#008080}.highlight .ow{color:#000000;font-weight:bold}.highlight .o{color:#000000;font-weight:bold}.highlight .w{color:#bbbbbb}.highlight{background-color:#f8f8f8}html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,menu,nav,output,ruby,section,summary,time,mark,audio,video{margin:0;padding:0;border:0;font:inherit;vertical-align:baseline}article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}ol,ul{list-style:none}table{border-collapse:collapse;border-spacing:0}body{box-sizing:border-box;color:#373737;background:#212121;font-size:16px;font-family:'Myriad Pro', Calibri, Helvetica, Arial, sans-serif;line-height:1.5;-webkit-font-smoothing:antialiased}h1,h2,h3,h4,h5,h6{margin:10px 0;font-weight:700;color:#222222;font-family:'Lucida Grande', 'Calibri', Helvetica, Arial, sans-serif;letter-spacing:-1px}h1{font-size:36px;font-weight:700}h2{padding-bottom:10px;font-size:32px;background:url("../images/bg_hr.png") repeat-x bottom}h3{font-size:24px}h4{font-size:21px}h5{font-size:18px}h6{font-size:16px}p{margin:10px 0 15px 0}footer p{color:#f2f2f2}a{text-decoration:none;color:#0F79D0;text-shadow:none;transition:color 0.5s ease;transition:text-shadow 0.5s ease;-webkit-transition:color 0.5s ease;-webkit-transition:text-shadow 0.5s ease;-moz-transition:color 0.5s ease;-moz-transition:text-shadow 0.5s ease;-o-transition:color 0.5s ease;-o-transition:text-shadow 0.5s ease;-ms-transition:color 0.5s ease;-ms-transition:text-shadow 0.5s ease}a:hover,a:focus{text-decoration:underline}footer a{color:#F2F2F2;text-decoration:underline}em,cite{font-style:italic}strong{font-weight:bold}img{position:relative;margin:0 auto;max-width:739px;padding:5px;margin:10px 0 10px 0;border:1px solid #ebebeb;box-shadow:0 0 5px #ebebeb;-webkit-box-shadow:0 0 5px #ebebeb;-moz-box-shadow:0 0 5px #ebebeb;-o-box-shadow:0 0 5px #ebebeb;-ms-box-shadow:0 0 5px #ebebeb}p img{display:inline;margin:0;padding:0;vertical-align:middle;text-align:center;border:none}pre,code{color:#222;background-color:#fff;font-family:Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace;font-size:14px;border-radius:2px;-moz-border-radius:2px;-webkit-border-radius:2px}pre{padding:10px;box-shadow:0 0 10px rgba(0,0,0,0.1);overflow:auto}code{padding:3px;margin:0 3px;box-shadow:0 0 10px rgba(0,0,0,0.1)}pre code{display:block;box-shadow:none}blockquote{color:#666;margin-bottom:20px;padding:0 0 0 20px;border-left:3px solid #bbb}ul,ol,dl{margin-bottom:15px}ul{list-style-position:inside;list-style:disc;padding-left:20px}ol{list-style-position:inside;list-style:decimal;padding-left:20px}dl dt{font-weight:bold}dl dd{padding-left:20px;font-style:italic}dl p{padding-left:20px;font-style:italic}hr{height:1px;margin-bottom:5px;border:none;background:url("../images/bg_hr.png") repeat-x center}table{border:1px solid #373737;margin-bottom:20px;text-align:left}th{font-family:'Lucida Grande', 'Helvetica Neue', Helvetica, Arial, sans-serif;padding:10px;background:#373737;color:#fff}td{padding:10px;border:1px solid #373737}form{background:#f2f2f2;padding:20px}.outer{width:100%}.inner{position:relative;max-width:640px;padding:20px 10px;margin:0 auto}#forkme_banner{display:block;position:absolute;top:0;right:10px;z-index:10;padding:10px 50px 10px 10px;color:#fff;background:url("../images/blacktocat.png") #0090ff no-repeat 95% 50%;font-weight:700;box-shadow:0 0 10px rgba(0,0,0,0.5);border-bottom-left-radius:2px;border-bottom-right-radius:2px}#header_wrap{background:#212121;background:-moz-linear-gradient(top, #373737, #212121);background:-webkit-linear-gradient(top, #373737, #212121);background:-ms-linear-gradient(top, #373737, #212121);background:-o-linear-gradient(top, #373737, #212121);background:linear-gradient(to top, #373737, #212121)}#header_wrap .inner{padding:50px 10px 30px 10px}#project_title{margin:0;color:#fff;font-size:42px;font-weight:700;text-shadow:#111 0px 0px 10px}#project_tagline{color:#fff;font-size:24px;font-weight:300;background:none;text-shadow:#111 0px 0px 10px}#downloads{position:absolute;width:210px;z-index:10;bottom:-40px;right:0;height:70px;background:url("../images/icon_download.png") no-repeat 0% 90%}.zip_download_link{display:block;float:right;width:90px;height:70px;text-indent:-5000px;overflow:hidden;background:url(../images/sprite_download.png) no-repeat bottom left}.tar_download_link{display:block;float:right;width:90px;height:70px;text-indent:-5000px;overflow:hidden;background:url(../images/sprite_download.png) no-repeat bottom right;margin-left:10px}.zip_download_link:hover{background:url(../images/sprite_download.png) no-repeat top left}.tar_download_link:hover{background:url(../images/sprite_download.png) no-repeat top right}#main_content_wrap{background:#f2f2f2;border-top:1px solid #111;border-bottom:1px solid #111}#main_content{padding-top:40px}#footer_wrap{background:#212121}@media screen and (max-width: 992px){img{max-width:100%}}@media screen and (max-width: 480px){body{font-size:14px}#downloads{display:none}.inner{min-width:320px;max-width:480px}#project_title{font-size:32px}h1{font-size:28px}h2{font-size:24px}h3{font-size:21px}h4{font-size:18px}h5{font-size:14px}h6{font-size:12px}code,pre{font-size:11px}}@media screen and (max-width: 320px){body{font-size:14px}#downloads{display:none}.inner{min-width:240px;max-width:320px}#project_title{font-size:28px}h1{font-size:24px}h2{font-size:21px}h3{font-size:18px}h4{font-size:16px}h5{font-size:14px}h6{font-size:12px}code,pre{min-width:240px;max-width:320px;font-size:11px}}@media only screen and (min-width: 500px){#main_content_wrap h2:not(.long){position:sticky;z-index:1;top:0;background:#f2f2f2;margin-left:-10px;margin-right:-10px;padding-left:10px;padding-right:10px}} |
| </style> |
| <meta charset="utf-8"> |
| <meta content="IE=edge" http-equiv="X-UA-Compatible"> |
| <meta content="width=device-width,maximum-scale=2" name="viewport"> |
| <style class="anchorjs"> |
| </style> |
| </head> |
| <body> |
| |
| <div class="outer" id="header_wrap"> |
| <header class="inner"> |
| <a id="forkme_banner"> |
| View on GitHub |
| </a> |
| <h1 id="project_title"> |
| Architectural Decision Records |
| </h1> |
| <h2 id="project_tagline"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Homepage of the ADR GitHub organization |
| </h2> |
| </header> |
| </div> |
| |
| <div class="outer" id="main_content_wrap"> |
| <section class="inner" id="main_content"> |
| <h1 id="architectural-decision-records-adrs"> |
| Architectural Decision Records (ADRs) |
| </h1> |
| <p> |
| An |
| <a> |
| Architectural Decision (AD) |
| </a> |
| is a justified design choice that addresses a functional or non-functional requirement that is architecturally significant. |
| An |
| <a> |
| Architecturally Significant Requirement (ASR) |
| </a> |
| is a requirement that has a measurable effect on the architecture and quality of a software and/or hardware system. |
| An |
| <em> |
| Architectural Decision Record (ADR) |
| </em> |
| captures a single AD and its rationale; |
| the collection of ADRs created and maintained in a project constitute its |
| <em> |
| decision log |
| </em> |
| . |
| All these are within the topic of Architectural Knowledge Management (AKM), but ADR usage can be extended to design and other decisions (“any decision record”). |
| </p> |
| <p> |
| The aim of the |
| <a> |
| GitHub adr organization |
| </a> |
| is to: |
| </p> |
| <ol> |
| <li> |
| Motivate the need for and benefits of AD capturing and establish a common vocabulary. |
| </li> |
| <li> |
| Strengthen the tooling around ADRs, in support of agile practices as well as iterative and incremental engineering processes. |
| </li> |
| <li> |
| Provide pointers to public knowledge in the context of AKM and ADRs. |
| </li> |
| </ol> |
| |
| <p> |
| The repository for the Website of the ADR organization is |
| <a> |
| https://github.com/adr/adr.github.io |
| </a> |
| . |
| </p> |
| <h2 id="adrs-in-the-media"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| ADRs in the Media |
| </h2> |
| <ul> |
| <li> |
| <a> |
| Love Unrequited: The Story of Architecture, Agile, and How Architecture Decision Records Brought Them Together |
| </a> |
| , Michael Keeling in the Pragmatic Designer column of IEEE Software Vol. 39 Issue 4 (2022) ( |
| <a> |
| PDF |
| </a> |
| ) |
| </li> |
| <li> |
| Chapter 3 of |
| <a> |
| “Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges” |
| </a> |
| in the Addison Wesley Signature Series at Pearson features six narratives guiding through the conceptual level of API design: 29 recurring decisions with options and criteria. Learn more in this |
| <a> |
| blog post |
| </a> |
| . |
| </li> |
| <li> |
| Architectural decision capturing is positioned as one of the essential activities in |
| <a> |
| Design Practice Reference |
| </a> |
| , a LeanPub e-Book. |
| </li> |
| <li> |
| (German) |
| <a> |
| Gut dokumentiert: Architecture Decision Records |
| </a> |
| by |
| <a> |
| @obfischer |
| </a> |
| published at |
| <a> |
| heise online |
| </a> |
| . |
| </li> |
| </ul> |
| |
| <h2 class="long" id="lightweight-adrs-should-be-adopted"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Lightweight ADRs Should be Adopted |
| </h2> |
| <p> |
| A “lightweight” ADR consists of |
| <a> |
| title, status, context, decision, and consequences |
| </a> |
| (according to |
| <a> |
| [Username Redacted] |
| </a> |
| ). |
| <a> |
| ThoughtWorks |
| </a> |
| listed architectural decision records as “adopt” at their |
| <a> |
| technology radar vol. 18 |
| </a> |
| : |
| <a> |
| https://www.thoughtworks.com/en-us/radar/techniques/lightweight-architecture-decision-records |
| </a> |
| </p> |
| <p> |
| We think that the considered options with their pros and cons are crucial to understand the reason of a chosen option. |
| <a> |
| MADR |
| </a> |
| — The Markdown Any/Architecture Decision Records (MADR: |
| <code class="language-plaintext highlighter-rouge"> |
| [ˈmæɾɚ] |
| </code> |
| ) in this ADR organization includes such tradeoff analysis information. |
| </p> |
| <h2 id="relation-of-adrs-madr-and-others"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Relation of ADRs, MADR, and Others |
| </h2> |
| <p> |
| <img alt="ADR" src="rick.jpg"> |
| </p> |
| <h2 id="sustainable-architectural-decisions"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Sustainable Architectural Decisions |
| </h2> |
| <p> |
| We base our work on the guidelines and principles in |
| <a> |
| Sustainable Architectural Decisions |
| </a> |
| by Zdun et al., for instance the Y-statement format suggested in that article. |
| However, we are open to other formats of ADRs as shown at |
| <a> |
| @joelparkerhenderson’s repository |
| </a> |
| . |
| </p> |
| <p> |
| In short, the Y-statement is as follows: |
| </p> |
| <blockquote> |
| <p> |
| In the context of |
| <code class="language-plaintext highlighter-rouge"> |
| <use case/user story u> |
| </code> |
| , facing |
| <code class="language-plaintext highlighter-rouge"> |
| <concern c> |
| </code> |
| we decided for |
| <code class="language-plaintext highlighter-rouge"> |
| <option o> |
| </code> |
| to achieve |
| <code class="language-plaintext highlighter-rouge"> |
| <quality q> |
| </code> |
| , accepting |
| <code class="language-plaintext highlighter-rouge"> |
| <downside d> |
| </code> |
| . |
| </p> |
| </blockquote> |
| <p> |
| The long form of it is as follows (extra section “because”): |
| </p> |
| <blockquote> |
| <p> |
| In the context of |
| <code class="language-plaintext highlighter-rouge"> |
| <use case/user story u> |
| </code> |
| , |
| facing |
| <code class="language-plaintext highlighter-rouge"> |
| <concern c> |
| </code> |
| we decided for |
| <code class="language-plaintext highlighter-rouge"> |
| <option o> |
| </code> |
| and neglected |
| <code class="language-plaintext highlighter-rouge"> |
| <other options> |
| </code> |
| , |
| to achieve |
| <code class="language-plaintext highlighter-rouge"> |
| <system qualities/desired consequences> |
| </code> |
| , |
| accepting |
| <code class="language-plaintext highlighter-rouge"> |
| <downside d/undesired consequences> |
| </code> |
| , |
| because |
| <code class="language-plaintext highlighter-rouge"> |
| <additional rationale> |
| </code> |
| . |
| </p> |
| </blockquote> |
| <p> |
| You can find more explanations and examples on Medium |
| <a> |
| Y-Statements - A Light Template for Architectural Decision Capturing |
| </a> |
| . |
| </p> |
| <p> |
| <a> |
| A Definition of Done for Architectural Decision Making |
| </a> |
| proposes five criteria and a checklist to decide when it is time to set the status of a single decision to “done”: evidence, criteria and alternatives, agreement, documentation, and realization/review plan. Here, we focus on the ‘D’ in |
| <em> |
| ecADR |
| </em> |
| . |
| </p> |
| <h2 id="existing-adr-templates"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Existing ADR Templates |
| </h2> |
| <ul> |
| <li> |
| Overview: |
| <a> |
| Architectural Decision Records |
| </a> |
| : collection of markdown templates converted to Markdown |
| </li> |
| <li> |
| <a> |
| MADR |
| </a> |
| : The Markdown Architecture Decision Records (MADR: |
| <code class="language-plaintext highlighter-rouge"> |
| [ˈmæɾɚ] |
| </code> |
| ). |
| <a> |
| matter |
| <code class="language-plaintext highlighter-rouge"> |
| [ˈmæɾɚ] |
| </code> |
| </a> |
| . |
| </li> |
| <li> |
| Comparison of seven templates: |
| <a> |
| Architectural Decision Guidance Across Projects - Problem Space Modeling, Decision Backlog Management and Cloud Computing Knowledge |
| </a> |
| . WICSA 2015: 85-94. |
| </li> |
| <li> |
| Context, background and examples of good and bad justifications can be found in |
| <a> |
| this blog post |
| </a> |
| . |
| </li> |
| </ul> |
| <h2 id="good-adrs-and-how-to-get-to-them"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Good ADRs (and how to get to them) |
| </h2> |
| <ul> |
| <li> |
| <a> |
| How to create ADRs — and how not to |
| </a> |
| collects good practices and anti-patterns |
| </li> |
| <li> |
| <a> |
| Architectural Significance Test and Some Core Decisions |
| </a> |
| </li> |
| <li> |
| <a> |
| The Markdown ADR (MADR) Template Explained and Distilled |
| </a> |
| </li> |
| <li> |
| Proposal for |
| <a> |
| A Definition of Done for Architectural Decision Making |
| </a> |
| </li> |
| </ul> |
| <h2 id="decision-capturing-tools"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Decision Capturing Tools |
| </h2> |
| <p> |
| <em> |
| Disclaimer: |
| </em> |
| The following list is rather inclusive. |
| Please find out about the status and the maturity of the list entries for yourself by following the links. |
| We are happy to include more candidate assets here. |
| </p> |
| <ul> |
| <li> |
| <a> |
| adr-manager |
| </a> |
| : Craft MADR 2.x templates directly in the Web Browser. |
| </li> |
| <li> |
| <a> |
| adr-tools |
| </a> |
| - bash scripts to manage ADRs in the |
| <a> |
| Nygard format |
| </a> |
| . |
| <a> |
| example |
| </a> |
| . |
| <ul> |
| <li> |
| Ansible script to install adr-tools: |
| <a> |
| ansible-adr-tools |
| </a> |
| </li> |
| <li> |
| C# rewrite: |
| <a> |
| adr-cli |
| </a> |
| </li> |
| <li> |
| Go rewrite: |
| <a> |
| adr |
| </a> |
| </li> |
| <li> |
| Java rewrite: |
| <a> |
| adr-j |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a> |
| adr-plugin |
| </a> |
| - plugin to explore and search ADRs within a backstage based developer portal. Search at scale across mutliple orgs/repos. |
| </li> |
| <li> |
| <a> |
| adr-viewer |
| </a> |
| - python application to generate a website from a set of ADRs. |
| </li> |
| </ul> |
| <p> |
| For a more detailed list for tooling for MADR, please head to |
| <a> |
| https://adr.github.io/madr/tooling.html |
| </a> |
| . |
| </p> |
| <h3 id="tooling-related-to-architecture-management"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Tooling related to architecture management |
| </h3> |
| <ul> |
| <li> |
| <a> |
| ArchUnit |
| </a> |
| : unit tests for architecture |
| </li> |
| <li> |
| <a> |
| docToolchain |
| </a> |
| : docToolchain is an implementation of the |
| <a> |
| docs-as-code |
| </a> |
| approach for software architecture plus some additional automation. |
| </li> |
| <li> |
| <a> |
| Structurizr |
| </a> |
| : Structurizr is a collection of tooling to help you visualise, document and explore your software architecture using the |
| <a> |
| C4 model |
| </a> |
| . |
| </li> |
| </ul> |
| <h3 id="interesting-but-unmaintained-tooling"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Interesting, but unmaintained tooling |
| </h3> |
| <ul> |
| <li> |
| <a> |
| adr-log |
| </a> |
| : Generates an architectural decision log out of MADRs. |
| </li> |
| <li> |
| <a> |
| ADMentor |
| </a> |
| Architectural Decision Modeling Add-In for |
| <a> |
| Sparx Enterprise Architect |
| </a> |
| </li> |
| <li> |
| <a> |
| eadlsync |
| </a> |
| : Synchronizes embedded architectural decision records with a repository of architectural decisions. |
| </li> |
| <li> |
| <a> |
| SE Repo |
| </a> |
| : Software Engineering Repository. A repository for versioning software engineering artifacts, which can be architectural decisions, patterns, and others. |
| </li> |
| </ul> |
| <h2 id="more-information"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| More Information |
| </h2> |
| <ul> |
| <li> |
| <a> |
| “An Adoption Model for Architectural Decision Making and Capturing” |
| </a> |
| </li> |
| <li> |
| <a> |
| Architectural Decisions — The Making Of |
| </a> |
| - provides some history on architecture decision records. |
| </li> |
| <li> |
| <a> |
| Architectural Decision Records (ADR): Open & Transparent Decision History |
| </a> |
| in the Open Practice Library |
| </li> |
| <li> |
| An AWS Prescriptive Guidance recommends |
| <a> |
| using architectural decision records to streamline technical decision-making for a software development project |
| </a> |
| . |
| </li> |
| </ul> |
| |
| <h2 id="contribute"> |
| <a aria-label="Anchor" class="anchorjs-link" data-anchorjs-icon="" style="font-style: normal; font-variant: normal; font-kerning: auto; font-optical-sizing: auto; font-feature-settings: normal; font-variation-settings: normal; font-weight: normal; font-stretch: normal; font-size: 1em; line-height: inherit; font-family: anchorjs-icons; position: absolute; margin-left: -1em; padding-right: 0.5em;"> |
| </a> |
| Contribute |
| </h2> |
| <p> |
| To improve this page, head to |
| <a> |
| https://github.com/adr/adr.github.io |
| </a> |
| , edit |
| <code class="language-plaintext highlighter-rouge"> |
| index.md |
| </code> |
| , and submit a pull request. |
| </p> |
| </section> |
| </div> |
| |
| <div class="outer" id="footer_wrap"> |
| <footer class="inner"> |
| <p class="copyright"> |
| Architectural Decision Records maintained by |
| <a> |
| adr |
| </a> |
| </p> |
| <p> |
| Published with |
| <a> |
| GitHub Pages |
| </a> |
| </p> |
| </footer> |
| </div> |
| </body> |
| </html> |
|
|
