Skip to content

Commit 45508b4

Browse files
committed
Fix minor typos
1 parent 8a4fa0a commit 45508b4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +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 **Architetecure Desicion Records (ADRs)** to document there design desicions.
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.
88

99
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.
1010

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

4545
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.
4646

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

4949
### Building Prototypes Before Committing
5050

@@ -111,7 +111,7 @@ structured
111111

112112
## Solutions
113113

114-
A project team or organisation chose an ADR and TDR like process for increasing the transparency of our architectural decision making process.
114+
A project team or organization chose an ADR and TDR like process for increasing the transparency of our architectural decision making process.
115115

116116
Important elements of the solution are:
117117

@@ -188,10 +188,10 @@ Drafted
188188

189189
- [Michael Nygards ADRs Idea](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
190190

191-
## Links with other innersource patterns
191+
## Links with other InnerSource patterns
192192

193193
- [Transparent Cross-Team Decision Making using RFCs](../2-structured/transparent-cross-team-decision-making-using-rfcs.md)
194-
- [Common Requierments](../2-structured/common-requirements.md)
194+
- [Common Requirements](../2-structured/common-requirements.md)
195195

196196
## Related material
197197

0 commit comments

Comments
 (0)