You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: patterns/1-initial/document-architecture-decisions.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ In an InnerSource project, where the entire organization must remain resilient t
16
16
- What criteria are used to decide between available options?
17
17
- What are the best approach to find the right people to decide and implement?
18
18
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.
20
20
21
21
- But how can a contributor understand the rationale behind current decisions?
22
22
- 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
84
84
- Each architectural decision requires careful preparation, considering current and future system requirements, technical constraints, and potential changes.
85
85
-**Continuous definition of technical debt**:
86
86
- 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**:
88
88
- Key stakeholders such as developers, product owners, and product managers provide valuable input on the direction and decisions related to specific projects.
89
89
-**Asynchronous decision-making**:
90
90
- 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
115
115
116
116
Important elements of the solution are:
117
117
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)**:
119
119
- Clear guidelines for when architectural decisions or technical debts require formal documentation and when they can be managed informally.
120
120
-**A template for ADR/TDR documentation**:
121
121
- 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:
126
126
- How to incorporate the feedback and adjust the ADR/TDR as needed.
127
127
- How to move the ADR/TDR towards a conclusion or final decision (e.g., with sign-off from relevant maintainers or decision-makers).
128
128
- 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**:
130
130
- Regularly refining the ADR/TDR templates and associated processes based on feedback and the evolving needs of the organization.
131
131
132
132
### Examples/Templates
@@ -204,4 +204,4 @@ Drafted
204
204
-[Requests for Comments](https://en.wikipedia.org/wiki/Request_for_Comments)
0 commit comments