Skip to content

Commit 6ef08c2

Browse files
committed
Moving Context section to the top
1 parent fbe867e commit 6ef08c2

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

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

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,29 @@ Identifying such conflicts or misunderstandings late in the development process
2727

2828
For an InnerSource project this situation happens more frequently when the project is maintained by multiple teams in the company i.e. shared ownership.
2929

30+
## Context
31+
32+
- **Shared ownership by many teams and contributors of the System Architecture**:
33+
- The architecture is a collective responsibility, involving diverse teams that each own different parts of the system.
34+
- **Overarching design decisions cannot always be made by a central body (e.g., a group of architects)**:
35+
- Due to time constraints and insufficient domain-specific knowledge, centralized decision-making is impractical in all cases.
36+
- **Decisions need preparation**:
37+
- Each architectural decision requires careful preparation, considering current and future system requirements, technical constraints, and potential changes.
38+
- **Continuous definition of technical debt**:
39+
- As you work on the system, you must document and track technical debt, preparing it for potential future changes or refactors.
40+
- **Input from various types of users**:
41+
- Key stakeholders such as developers, product owners, and product managers provide valuable input on the direction and decisions related to specific projects.
42+
- **Asynchronous decision-making**:
43+
- 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.
44+
- **Desire to document decisions**:
45+
- It’s essential to record decisions and technical deps in writing to create a clear, traceable record, ensuring that all stakeholders can refer back to the rationale behind every architectural choice made.
46+
- **Define a revision process**:
47+
- Update the records (ADR and TDR) to document, assess, and refine key architectural decisions and technical deps, ensuring alignment with evolving requirements and technologies.
48+
- Regularly review decisions to confirm their practical application; if not effectively implemented, reevaluate and adjust accordingly.
49+
- **Define Governance**:
50+
- Facilitate the process by providing clear moderation and oversight.
51+
- Establish a mentoring framework to guide and support stakeholders throughout the process.
52+
3053
## Forces
3154

3255
- Often, the involved parties want to make decisions promptly, balancing speed with quality.
@@ -102,29 +125,6 @@ This approach leads to greater innovation, closer collaboration, and the widespr
102125

103126
Like any process, this requires ongoing refinement to maintain its effectiveness. Regular feedback may reveal areas for improvement, such as adjustments to the ADRs- and TDRs-templates or the decision-making process itself, ensuring that it remains inclusive, collaborative, and adaptive. By supporting an environment of continuous learning and improvement, a team not only enhance the decisions they make today but also create a sustainable foundation for future growth and innovation.
104127

105-
## Context
106-
107-
- **Shared ownership by many teams and contributors of the System Architecture**:
108-
- The architecture is a collective responsibility, involving diverse teams that each own different parts of the system.
109-
- **Overarching design decisions cannot always be made by a central body (e.g., a group of architects)**:
110-
- Due to time constraints and insufficient domain-specific knowledge, centralized decision-making is impractical in all cases.
111-
- **Decisions need preparation**:
112-
- Each architectural decision requires careful preparation, considering current and future system requirements, technical constraints, and potential changes.
113-
- **Continuous definition of technical debt**:
114-
- As you work on the system, you must document and track technical debt, preparing it for potential future changes or refactors.
115-
- **Input from various types of users**:
116-
- Key stakeholders such as developers, product owners, and product managers provide valuable input on the direction and decisions related to specific projects.
117-
- **Asynchronous decision-making**:
118-
- 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.
119-
- **Desire to document decisions**:
120-
- It’s essential to record decisions and technical deps in writing to create a clear, traceable record, ensuring that all stakeholders can refer back to the rationale behind every architectural choice made.
121-
- **Define a revision process**:
122-
- Update the records (ADR and TDR) to document, assess, and refine key architectural decisions and technical deps, ensuring alignment with evolving requirements and technologies.
123-
- Regularly review decisions to confirm their practical application; if not effectively implemented, reevaluate and adjust accordingly.
124-
- **Define Governance**:
125-
- Facilitate the process by providing clear moderation and oversight.
126-
- Establish a mentoring framework to guide and support stakeholders throughout the process.
127-
128128
### Architecture Decision Record (ADR) Tooling
129129

130130
Architecture Decision Records (ADRs) provide a structured way to document design decisions and their rationale, ensuring clarity and continuity in software projects. Several tools facilitate the creation and management of ADRs, making it easier for teams to track and share their architectural choices.

0 commit comments

Comments
 (0)