Skip to content

Architecture practice

Documenting Integration Decisions: Keep the Why Behind the Architecture

Integration & Operations3 min read

A diagram shows what is connected. An interface contract shows what systems exchange. A decision log captures why the design was chosen, which alternatives were rejected and when the decision should be reviewed. That history matters when the integration changes, fails or lands with a team that was not part of the original design.

Three people reviewing integration architecture diagrams on a whiteboard. AI-generated illustration.AI-generated
Document the reasoning while the decision is still fresh — not months later when someone has to reconstruct it.
Main topic

ARCHITECTURE RECORDS

Three artifacts. Three different jobs.

These records complement each other. They should not be forced into one document.

ARCHITECTURE RECORDS

System diagram

What is connected?

Shows systems, dependencies and the main direction of data or events. It gives readers the landscape quickly, but usually not the reasoning behind a design choice.

Decision log

Why did we choose this design?

Records the decision, the context that made it necessary, the alternatives considered and the consequences the team accepted.

Interface contract

What do the systems promise each other?

Defines the data, semantics, behavior and expectations at the boundary between systems — including what each side may rely on.

The diagram explains the shape. The contract explains the boundary. The decision log explains the why.

LIVING HISTORY

Keep the history. Do not overwrite it.

Custom decision history: a new event design supersedes the batch decision without erasing it.

Architecture decisions change. That does not make the previous decision useless.

Keep the original entry, mark it as superseded and link it to the decision that replaced it. Future teams can then see what changed, why it changed and which assumptions no longer apply.

A decision log is most valuable when it explains the transition between decisions, not just the current state.

  1. Diagram: What is connected?
  2. Decision log: Why this approach?
  3. Interface contract: How does the connection behave?

Frequently asked questions about decision logs

How detailed should a decision log be?

Detailed enough that someone who was not in the meeting can understand what was decided, why it mattered and what assumptions the decision relied on. It should not become a meeting transcript.

Does every technical decision need its own entry?

No. Record decisions that materially affect architecture, ownership, data, security, operability or future change. Routine implementation choices do not need the same treatment.

Does a decision log replace interface documentation?

No. The interface contract describes what the systems exchange and how the boundary behaves. The decision log explains why that design was chosen and what alternatives were considered.

KEEP THE CONTEXT ATTACHED

Keep the decision attached to the integration it affects.

A decision log becomes much more useful when readers can move directly from the reasoning to the systems, interface or contract affected by it.

The goal is not more documentation. It is less reconstruction later.

  1. Link the decision to the affected systems and interface

  2. Reference the contract, event or data flow where relevant

  3. Record the alternatives that were seriously considered

  4. Name the owner and the people involved in the review

Further steps (2)
  1. Capture the operational consequences the team accepted

  2. Define what would trigger a future review

PRACTICAL CHECKLIST

What a useful decision log should contain

Keep the structure consistent enough to scan, but lightweight enough that teams will maintain it.

  • Decision

    What was chosen, and which system or process boundary does it apply to?

  • Context

    Which business need, constraint or risk made the decision necessary?

  • Systems & ownership

    Which systems are affected, and who owns the business and technical consequences?

  • Alternatives

    Which realistic options were considered, and why were they not chosen?

More review criteria (3)
  • Operational consequences

    What does the decision mean for data, security, error handling, support and future change?

  • Date & responsibility

    When was the decision made, and who is accountable for it?

  • Review trigger

    Which change in process, volume, platform, risk or ownership should reopen the decision?

START SMALL

Start with one decision that is worth preserving.

You do not need a documentation program. Start with one architecture choice that would be painful to reconstruct six months from now.

Make system boundaries and handoffs visible together.
Custom architecture map: interface, contract and decision remain linked but distinct.
  1. 01

    Record the context

    Capture the problem, affected systems, constraints and the decision that needs to be made.

  2. 02

    Review the decision

    Compare the realistic options, record the trade-offs and agree on the consequences the team is accepting.

  3. 03

    Maintain the history

    When the architecture changes, preserve the original entry and link the decision that replaces it.

Sources and further reading

Primary documentation and reference material for architecture decision records, integration design and related operating practices.

  1. Salesforce Architects – Integration Decision GuidesChecked on

    Supports the structure and distinction of architecture decisions, integration patterns, and decision records; recheck all three primary sources before publication without claiming endorsement by Salesforce or Microsoft.

  2. Salesforce Architects – Integration PatternsChecked on

    Supports the structure and distinction of architecture decisions, integration patterns, and decision records; recheck all three primary sources before publication without claiming endorsement by Salesforce or Microsoft.

  3. Microsoft Azure Well-Architected – Architecture Decision RecordChecked on

    Supports the structure and distinction of architecture decisions, integration patterns, and decision records; recheck all three primary sources before publication without claiming endorsement by Salesforce or Microsoft.

Topics in this article