Skip to content

Commit 538a0fd

Browse files
committed
Fix: Merge the changes that Sebastian motivated. Many Thanks!
1 parent 2d1b81c commit 538a0fd

File tree

2 files changed

+16
-19
lines changed

2 files changed

+16
-19
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Our mission
9292
* [InnerSource Ambassadors](/patterns/1-initial/innersource-ambassador.md) - *When driving InnerSource adoption through a large, decentralized organization it is hard to understand and address the local challenges that come up in different departments and regions. Local volunteers, called InnerSource Ambassadors, provide localized support by promoting InnerSource principles and acting as a communication bridge between their teams and the ISPO.*
9393
* [Circle Communities](/patterns/1-initial/circle-communities.md) - *InnerSource adoption is slow in organizations due to limited understanding, engagement, and contextual relevance. Circle Communities address this by fostering synchronous conversations that build connections, close knowledge gaps, and cultivate collaboration and continuous learning.*
9494
* [Internal Developer Platform](/patterns/1-initial/internal-developer-platform.md) - *As InnerSource adoption increases throughout an organisation, it is not unusual that project teams start to face inefficiencies in scaling their efforts due to fragmented tooling, environments, and workflows. An Internal Developer Platform (IDP) provides a way to tackle this type of challenges through a centralized, self-service system that standardizes development environments and integrates tools to enhance consistency, collaboration, and developer productivity.*
95-
* [Document Architecture Decisions](/patterns/1-initial/document-architecture-decisions.md) - *InnerSource projects that want to achieve high participation rates and make the best possible decisions for everybody involved need to find ways to create participatory format for all system components, tools and workflows. Michael Nygard announced 2011 the idea to document architecture decision with a simple markdown template and shared it with a simple git project. Today this **ADR tool** is well proven and a many of teams around the globe use **Architetecure Desicion Records (ADRs)** to document there design desicions.*
95+
* [Document Architecture Decisions](/patterns/1-initial/document-architecture-decisions.md) - *InnerSource contributors often face challenges in grasping the system's design rationale, which can result in misalignment between maintainers, contributors, and stakeholders—potentially discouraging participation. To enhance decision-making and transparency, we recommend capturing architecture decisions and their consequences in a lightweight, accessible format to streamline onboarding, clarify decisions, and support long-term project sustainability.*
9696

9797
<!--
9898
NOTE: The 'Initial' Patterns below don't have a Patlet yet, which is essential for readers to quickly browse our patterns.

patterns/1-initial/document-architecture-decisions.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ Document Architecture Decisions
44

55
## Patlet
66

7-
InnerSource projects that want to achieve high participation rates and make the best possible decisions for everybody involved need to find ways to create participatory format for all system components, tools and workflows. Michael Nygard announced 2011 the idea to document architecture decision with a simple markdown template and shared it with a simple git project. Today this **ADR tool** is well proven and a many of teams around the globe use **Architecture Desicion Records (ADRs)** to document there design desicions.
8-
9-
Another important aspect of defining architectural decisions is documenting consequences. In Technical Debt Records, Dr. Michael Stal explores the systematic tracking and management of technical debt in software development using **Technical Debt Records (TDRs)**. Similar to how Architecture Design Records (ADRs) capture architectural decisions, TDRs document trade-offs in code quality made to accelerate delivery. The TDRs provides a detailed template for documenting technical debt, and Christoph Kappel introduces a record tool to streamline the process of ADRs and TDRs.
7+
InnerSource contributors often face challenges in grasping the system's design rationale, which can result in misalignment between maintainers, contributors, and stakeholders—potentially discouraging participation. To enhance decision-making and transparency, we recommend capturing architecture decisions and their consequences in a lightweight, accessible format to streamline onboarding, clarify decisions, and support long-term project sustainability.
108

119
## Problem
1210

@@ -46,7 +44,7 @@ In one such scenario, the system's scalability is identified as a critical issue
4644

4745
To address these possibilities, the teams convene a series of writers' workshops. Here, architects, maintainers, and engineers document the technical debt in their respective areas and outline how each solution impacts the project. These workshops were designed to help committers produce well-documented decisions using structured templates, such as **Architecture Decision Records (ADRs)** and **Technical Debt Records (TDRs)**. By utilizing these templates, the workshops supported a shared understanding of existing trade-offs and supported open, transparent discussions. The ADRs captured the rationale behind architectural choices, while the TDRs helped document the technical debt in various parts of the system. This approach not only ensured a thorough exploration of options but also created a traceable record of decisions, making it easier for all stakeholders to follow the reasoning behind each direction taken.
4846

49-
- [Writers Workshop Pattern](https://hillside.net/conferences/plop/235-how-to-hold-a-writers-workshop)
47+
- [Writers Workshop](https://hillside.net/conferences/plop/235-how-to-hold-a-writers-workshop)
5048

5149
### Building Prototypes Before Committing
5250

@@ -107,10 +105,6 @@ Like any process, this requires ongoing refinement to maintain its effectiveness
107105
- No one discusses the architectural decisions and technical deps with a broader audience.
108106
- The owners continuously evaluate upcoming challenges and strive for excellence, refusing to settle for a "good enough" solution.
109107

110-
## Sketch
111-
112-
structured
113-
114108
## Solutions
115109

116110
A project team or organization chose an ADR and TDR like process for increasing the transparency of our architectural decision making process.
@@ -163,19 +157,14 @@ The ADR/TDR approach also carries risks that a team want to acknowledge:
163157

164158
## Rationale
165159

166-
??
160+
InnerSource projects that want to achieve high participation rates and make the best possible decisions for everybody involved need to find ways to create participatory format for all system components, tools and workflows. Michael Nygard announced 2011 the idea to document architecture decision with a simple markdown template and shared it with a simple git project. Today this **ADR tool** is well proven and a many of teams around the globe use **Architecture Desicion Records (ADRs)** to document there design desicions.
161+
162+
Another important aspect of defining architectural decisions is documenting consequences. In Technical Debt Records, Dr. Michael Stal explores the systematic tracking and management of technical debt in software development using **Technical Debt Records (TDRs)**. Similar to how Architecture Design Records (ADRs) capture architectural decisions, TDRs document trade-offs in code quality made to accelerate delivery. The TDRs provides a detailed template for documenting technical debt, and Christoph Kappel introduces a record tool to streamline the process of ADRs and TDRs.
167163

168164
## Known Instances
169165

170-
- [ADRs at Google Cloud](https://cloud.google.com/architecture/architecture-decision-records)
171-
- [Amazon: AWS Prescriptive Guidance: ADR Process](https://docs.aws.amazon.com/prescriptive-guidance/latest/architectural-decision-records/welcome.html)
172-
- [GitHub: ADR GitHub organization](https://adr.github.io/)
173166
- [How use Spotify ADRs](https://engineering.atspotify.com/2020/04/when-should-i-write-an-architecture-decision-record/)
174-
- [Joel Parker Templates to ADR](https://github.com/joelparkerhenderson/architecture-decision-record)
175-
- [RedHat: Why you should use ADRs](https://www.redhat.com/en/blog/architecture-decision-records)
176-
- [Using Architecture Decision Records in Open Source Projects—An MSR Study on GitHub](https://ieeexplore.ieee.org/document/10155430)
177167
- [SAP- Cross Product Architecture](https://community.sap.com/t5/technology-blogs-by-sap/cross-product-architecture-embracing-conway-s-law-for-better-software/ba-p/13648600)
178-
- [Software Architecture Documentation Starter with arc42 and C4 Model](https://github.com/bitsmuggler/arc42-c4-software-architecture-documentation-example)
179168

180169
## Status
181170

@@ -197,13 +186,21 @@ The ADR/TDR approach also carries risks that a team want to acknowledge:
197186

198187
## Related Material
199188

189+
- [ADR Hub](https://adr.github.io/)
190+
- [ADRs at Google Cloud](https://cloud.google.com/architecture/architecture-decision-records)
191+
- [Amazon: AWS Prescriptive Guidance: ADR Process](https://docs.aws.amazon.com/prescriptive-guidance/latest/architectural-decision-records/welcome.html)
200192
- [Architectural Decision](https://en.wikipedia.org/wiki/Architectural_decision)
201193
- [Architectural Decision Records](https://adr.github.io)
202194
- [Architectural Decisions — The Making Of](https://ozimmer.ch/practices/2020/04/27/ArchitectureDecisionMaking.html)
195+
- [GitHub: ADR GitHub organization](https://adr.github.io/)
203196
- [Learnings from using ADR in a real project](https://blog.unexist.dev/documentation/myself/2021/08/18/learnings-from-using-adr-in-a-real-project.html)
197+
- [Joel Parker Templates to ADR](https://github.com/joelparkerhenderson/architecture-decision-record)
198+
- [How to write effective documentation for your open source project?](https://opensource.com/article/20/3/documentation)
199+
- [RedHat: Why you should use ADRs](https://www.redhat.com/en/blog/architecture-decision-records)
200+
- [Software Architecture Documentation Starter with arc42 and C4 Model](https://github.com/bitsmuggler/arc42-c4-software-architecture-documentation-example)
204201
- [Technical Debt Records](https://github.com/ms1963/TechnicalDebtRecords)
205202
- [Technical Debt Records Idea](https://www.heise.de/blog/Technical-Debt-Records-Dokumentation-technischer-Schulden-9876115.html)
206203
- [Requests for Comments](https://en.wikipedia.org/wiki/Request_for_Comments)
207-
- [30-years-of-rfcs](https://www.rfc-editor.org/rfc/rfc2555.txt)
204+
- [Using Architecture Decision Records in Open Source Projects—An MSR Study on GitHub](https://ieeexplore.ieee.org/document/10155430)
208205
- [Y-Statements](https://medium.com/olzzio/y-statements-10eb07b5a177)
209-
- [ADR Hub](https://adr.github.io/)
206+
- [30-years-of-rfcs](https://www.rfc-editor.org/rfc/rfc2555.txt)

0 commit comments

Comments
 (0)