Linked.Archi

Linked.Archi Core Deliverable Templates

Deliverable Templates

https://meta.linked.archi/core-deliverable-templates#

Kalin Maldzhanski

Framework-agnostic deliverable templates of common architecture documents, produced from a model in any language: each section answers the concerns it names by asking the core model questions. Also the presentation formats every deliverable template renders in. Language- and framework-specific templates (e.g., the ArchiMate Architecture Definition Document) are defined with their language or framework.

Architecture Overview Document

A high-level architecture document providing stakeholders with an overview of the architecture landscape, component inventory, dependencies, and standards compliance. Suitable for governance reviews and onboarding.

Required Viewpoints: LandscapeOverview StakeholderMap ComponentCatalog DependencyMatrix StandardsCompliance
Target Purposes: Informing, Governing
Available Formats: MarkdownFormat, HTMLFormat, PDFFormat
Produced for: ?model

Sections

1 1. Architecture Landscape
What does the architecture consist of, and what of it is baseline, target or awaiting approval?
Viewpoint: LandscapeOverview Result key: landscape
Concerns: EvolutionConcern StructureConcern
Asks:
  1. What does the model contain?
  2. What is baseline, target or still awaiting approval?
2 2. Stakeholder Analysis
Who are the stakeholders, and which views address their concerns?
Viewpoint: StakeholderMap Result key: stakeholders
Concerns: StakeholderConcern
3 3. Component Inventory
Is every component defined, and named once?
Viewpoint: ComponentCatalog Result key: components
Concerns: QualityConcern StructureConcern
Asks:
  1. Which elements have no definition?
  2. Which elements share a name with another of the same type?
4 4. Dependency Analysis
Does every element take part in the architecture's dependencies?
Viewpoint: DependencyMatrix Result key: dependencies
Concerns: DependencyConcern QualityConcern
Asks:
  1. Which elements take part in no relationship?
5 5. Standards Compliance
Does the description follow defined viewpoints, present every element, and keep its relationships whole?
Viewpoint: StandardsCompliance Result key: standardsCompliance
Concerns: GovernanceConcern QualityConcern
Asks:
  1. Which views follow a viewpoint the loaded metamodels do not define?
  2. Which elements appear in no view?
  3. Which relationships are out of step with their direct triple?

Solution Design Document

A solution-level architecture document covering process design, interface design, deployment topology, and architecture decisions. Used by solution architects and development teams during design and implementation.

Required Viewpoints: LandscapeOverview ProcessFlow InterfaceMap DeploymentMap DecisionLog
Target Purposes: Designing
Available Formats: MarkdownFormat, HTMLFormat
Produced for: ?model

Sections

1 1. Solution Context
What does the model of the solution contain?
Viewpoint: LandscapeOverview Result key: solutionContext
Concerns: StructureConcern
Asks:
  1. What does the model contain?
2 2. Process Design
Process flows showing activities, decision points, and handoffs.
Viewpoint: ProcessFlow Result key: processDesign
Concerns: BehaviorConcern
3 3. Interface Design
Interface map showing component connections, protocols, and data flows.
Viewpoint: InterfaceMap Result key: interfaceDesign
Concerns: DependencyConcern IntegrationConcern
4 4. Deployment Design
Deployment map showing where components run and hosting relationships.
Viewpoint: DeploymentMap Result key: deploymentDesign
Concerns: DeploymentConcern
5 5. Architecture Decisions
Log of architecture decisions with context, rationale, and status.
Viewpoint: DecisionLog Result key: architectureDecisions
Concerns: GovernanceConcern

Change Impact Assessment

An assessment document for evaluating the impact of a proposed architecture change to one element. Covers impact propagation, the views that present the element, the architecture states involved, and migration planning. Used for change governance and decision-making.

Required Viewpoints: ImpactAnalysis DependencyMatrix GapAnalysis Roadmap
Target Purposes: Deciding, Governing
Available Formats: MarkdownFormat, PDFFormat, SlideFormat
Produced for: ?model ?focus

Sections

1 1. Impact Analysis
What is the element related to, and what reaches it within two steps — what is affected if it changes?
Viewpoint: ImpactAnalysis Result key: impact
Concerns: DependencyConcern EvolutionConcern
Asks:
  1. What is this element directly related to?
  2. What reaches this element within two hops?
2 2. Dependency Assessment
Which views present the element and its dependencies, and need revising with the change?
Viewpoint: DependencyMatrix Result key: dependencyAssessment
Concerns: DependencyConcern
Asks:
  1. Which views show this element?
3 3. Gap Analysis
What in the model is baseline, target or still awaiting approval?
Viewpoint: GapAnalysis Result key: gapAnalysis
Concerns: EvolutionConcern
Asks:
  1. What is baseline, target or still awaiting approval?
4 4. Migration Roadmap
Planned evolution steps to implement the change.
Viewpoint: Roadmap Result key: migrationRoadmap
Concerns: EvolutionConcern
Source: linked-archi-meta • Linked.Archi