Skip to content

Commit 8a4fa0a

Browse files
committed
Fix: Formatting
1 parent 2d69ffb commit 8a4fa0a

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
@@ -16,7 +16,7 @@ In an InnerSource project, where the entire organization must remain resilient t
1616
- What criteria are used to decide between available options?
1717
- What are the best approach to find the right people to decide and implement?
1818

19-
To support an open environment for contributions and make changes easier to implement, contributors need clarity.
19+
To support an open environment for contributions and make changes easier to implement, contributors need clarity.
2020

2121
- But how can a contributor understand the rationale behind current decisions?
2222
- How can a team effectively discuss the risks of a radical refactor or redesign?
@@ -84,7 +84,7 @@ Like any process, this requires ongoing refinement to maintain its effectiveness
8484
- Each architectural decision requires careful preparation, considering current and future system requirements, technical constraints, and potential changes.
8585
- **Continuous definition of technical debt**:
8686
- As you work on the system, you must document and track technical debt, preparing it for potential future changes or refactors.
87-
- **Input from various types of users**:
87+
- **Input from various types of users**:
8888
- Key stakeholders such as developers, product owners, and product managers provide valuable input on the direction and decisions related to specific projects.
8989
- **Asynchronous decision-making**:
9090
- Given the diverse stakeholders, decisions must be made asynchronously, avoiding the need for frequent synchronous meetings and instead encouraging discussions via writers' workshops and ongoing documentation.
@@ -115,7 +115,7 @@ A project team or organisation chose an ADR and TDR like process for increasing
115115

116116
Important elements of the solution are:
117117

118-
- **A description of when to document an ADR/TDR (and when not to)**:
118+
- **A description of when to document an ADR/TDR (and when not to)**:
119119
- Clear guidelines for when architectural decisions or technical debts require formal documentation and when they can be managed informally.
120120
- **A template for ADR/TDR documentation**:
121121
- Should encourage the author to examine the decision from multiple perspectives (technical, business, user, etc.).
@@ -126,7 +126,7 @@ Important elements of the solution are:
126126
- How to incorporate the feedback and adjust the ADR/TDR as needed.
127127
- How to move the ADR/TDR towards a conclusion or final decision (e.g., with sign-off from relevant maintainers or decision-makers).
128128
- The use of appropriate tools, considering that non-technical stakeholders may not have direct access to source control or specialized software. Publish the decsions to a website or wiki.
129-
- **A commitment to iterating on the ADR/TDR templates and process**:
129+
- **A commitment to iterating on the ADR/TDR templates and process**:
130130
- Regularly refining the ADR/TDR templates and associated processes based on feedback and the evolving needs of the organization.
131131

132132
### Examples/Templates
@@ -204,4 +204,4 @@ Drafted
204204
- [Requests for Comments](https://en.wikipedia.org/wiki/Request_for_Comments)
205205
- [30-years-of-rfcs](https://www.rfc-editor.org/rfc/rfc2555.txt)
206206
- [Y-Statements](https://medium.com/olzzio/y-statements-10eb07b5a177)
207-
- [ADR Hub](https://adr.github.io/)
207+
- [ADR Hub](https://adr.github.io/)

0 commit comments

Comments
 (0)