Linked.Archi

Deliverable Templates

Deliverable Templates

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

Service Catalog Document

A Backstage-based service catalog document progressing from a full service inventory through ownership governance to API dependency analysis. Suitable for platform engineering reviews and developer onboarding.

Template: templates/service-catalog-document.md.hbs
Required Viewpoints: ServiceCatalog OwnershipMatrix APIDependency
Target Purposes: Informing, Governing
Available Formats: MarkdownFormat, HTMLFormat

Sections

1 1. Service Catalog
Inventory of all registered components, systems, and APIs.
Viewpoint: ServiceCatalog Result key: serviceCatalog
SPARQL Query 
PREFIX bs:   <https://meta.linked.archi/backstage/onto#>
PREFIX arch: <https://meta.linked.archi/core#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>

SELECT ?element ?label ?type ?description ?domain ?system WHERE {
    ?element a ?type ;
             skos:prefLabel ?label .
    VALUES ?type { bs:Component bs:System bs:API bs:Resource }
    OPTIONAL { ?element skos:definition ?description }
    OPTIONAL {
        ?element bs:belongsToDomain ?dom .
        ?dom skos:prefLabel ?domain .
        FILTER(lang(?domain) = "en")
    }
    OPTIONAL {
        ?element bs:partOfSystem ?sys .
        ?sys skos:prefLabel ?system .
        FILTER(lang(?system) = "en")
    }
    FILTER(lang(?label) = "en")
} ORDER BY ?type ?domain ?label
2 2. Ownership Matrix
Which groups own which components and systems.
Viewpoint: OwnershipMatrix Result key: ownershipMatrix
SPARQL Query 
PREFIX bs:   <https://meta.linked.archi/backstage/onto#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>

SELECT ?element ?elementLabel ?type ?owner ?ownerLabel WHERE {
    ?element a ?type ;
             skos:prefLabel ?elementLabel ;
             bs:ownedBy ?owner .
    ?owner skos:prefLabel ?ownerLabel .
    VALUES ?type { bs:Component bs:System bs:API bs:Resource }
    FILTER(lang(?elementLabel) = "en")
    FILTER(lang(?ownerLabel) = "en")
} ORDER BY ?ownerLabel ?type ?elementLabel
3 3. API Dependencies
API provision and consumption relationships across components.
Viewpoint: APIDependency Result key: apiDependencies
SPARQL Query 
PREFIX bs:   <https://meta.linked.archi/backstage/onto#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>

SELECT ?api ?apiLabel ?provider ?providerLabel ?consumer ?consumerLabel WHERE {
    ?api a bs:API ;
         skos:prefLabel ?apiLabel .
    OPTIONAL {
        ?provider bs:providesAPI ?api .
        ?provider skos:prefLabel ?providerLabel .
        FILTER(lang(?providerLabel) = "en")
    }
    OPTIONAL {
        ?consumer bs:consumesAPI ?api .
        ?consumer skos:prefLabel ?consumerLabel .
        FILTER(lang(?consumerLabel) = "en")
    }
    FILTER(lang(?apiLabel) = "en")
} ORDER BY ?apiLabel ?providerLabel ?consumerLabel
📄 Template Preview 
---
title: "Service Catalog Document"
date: "{{meta.date}}"
author: "{{meta.author}}"
status: "{{meta.status}}"
version: "{{meta.version}}"
---

# Service Catalog Document

{{#if meta.description}}
> {{meta.description}}
{{/if}}

| Property | Value |
|----------|-------|
| Date | {{meta.date}} |
| Author | {{meta.author}} |
| Status | {{meta.status}} |
| Version | {{meta.version}} |
| Metamodel | Backstage Catalog |

---

## 1. Service Catalog

Inventory of all registered components, systems, and APIs.

### All Entities

| Entity | Type | Domain | System | Description |
|--------|------|--------|--------|-------------|
{{#each serviceCatalog}}
| {{this.label}} | {{this.type}} | {{this.domain}} | {{this.system}} | {{this.description}} |
{{/each}}

---

## 2. Ownership Matrix

Which groups own which components and systems.

### Ownership

| Owner | Entity | Type |
|-------|--------|------|
{{#each ownershipMatrix}}
| {{this.ownerLabel}} | {{this.elementLabel}} | {{this.type}} |
{{/each}}

---

## 3. API Dependencies

API provision and consumption relationships across components.

### API Dependency Map

| API | Provider | Consumer |
|-----|----------|----------|
{{#each apiDependencies}}
| {{this.apiLabel}} | {{this.providerLabel}} | {{this.consumerLabel}} |
{{/each}}

System Architecture Document

A Backstage-based system architecture document progressing from domain organization through system dependencies to API landscape analysis. Suitable for architecture reviews and system design discussions.

Template: templates/system-architecture-document.md.hbs
Required Viewpoints: DomainOverview SystemDependency APIDependency
Target Purposes: Designing, Informing
Available Formats: MarkdownFormat, HTMLFormat

Sections

1 1. Domain Overview
Domains and their constituent systems and components.
Viewpoint: DomainOverview Result key: domainOverview
SPARQL Query 
PREFIX bs:   <https://meta.linked.archi/backstage/onto#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>

SELECT ?domain ?domainLabel ?description ?system ?systemLabel ?component ?componentLabel WHERE {
    ?domain a bs:Domain ;
            skos:prefLabel ?domainLabel .
    OPTIONAL { ?domain skos:definition ?description }
    OPTIONAL {
        ?system bs:belongsToDomain ?domain ;
                a bs:System ;
                skos:prefLabel ?systemLabel .
        FILTER(lang(?systemLabel) = "en")
        OPTIONAL {
            ?component bs:partOfSystem ?system ;
                       a bs:Component ;
                       skos:prefLabel ?componentLabel .
            FILTER(lang(?componentLabel) = "en")
        }
    }
    FILTER(lang(?domainLabel) = "en")
} ORDER BY ?domainLabel ?systemLabel ?componentLabel
2 2. System Dependencies
System-level dependencies including APIs and resources.
Viewpoint: SystemDependency Result key: systemDependencies
SPARQL Query 
PREFIX bs:   <https://meta.linked.archi/backstage/onto#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>

SELECT ?system ?systemLabel ?dependsOn ?dependsOnLabel ?dependencyType WHERE {
    ?system a bs:System ;
            skos:prefLabel ?systemLabel .
    {
        ?comp bs:partOfSystem ?system .
        ?comp bs:consumesAPI ?api .
        ?provider bs:providesAPI ?api .
        ?provider bs:partOfSystem ?depSys .
        ?depSys skos:prefLabel ?dependsOnLabel .
        BIND("API" AS ?dependencyType)
        BIND(?depSys AS ?dependsOn)
        FILTER(?system != ?depSys)
    } UNION {
        ?comp bs:partOfSystem ?system .
        ?comp bs:usesResource ?res .
        ?res skos:prefLabel ?dependsOnLabel .
        BIND(?res AS ?dependsOn)
        BIND("Resource" AS ?dependencyType)
    }
    FILTER(lang(?systemLabel) = "en")
    FILTER(lang(?dependsOnLabel) = "en")
} ORDER BY ?systemLabel ?dependencyType ?dependsOnLabel
3 3. API Landscape
API provision and consumption across the system boundary.
Viewpoint: APIDependency Result key: apiLandscape
SPARQL Query 
PREFIX bs:   <https://meta.linked.archi/backstage/onto#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>

SELECT ?api ?apiLabel ?description ?provider ?providerLabel ?consumer ?consumerLabel WHERE {
    ?api a bs:API ;
         skos:prefLabel ?apiLabel .
    OPTIONAL { ?api skos:definition ?description }
    OPTIONAL {
        ?provider bs:providesAPI ?api .
        ?provider skos:prefLabel ?providerLabel .
        FILTER(lang(?providerLabel) = "en")
    }
    OPTIONAL {
        ?consumer bs:consumesAPI ?api .
        ?consumer skos:prefLabel ?consumerLabel .
        FILTER(lang(?consumerLabel) = "en")
    }
    FILTER(lang(?apiLabel) = "en")
} ORDER BY ?apiLabel
📄 Template Preview 
---
title: "System Architecture Document"
date: "{{meta.date}}"
author: "{{meta.author}}"
status: "{{meta.status}}"
version: "{{meta.version}}"
---

# System Architecture Document

{{#if meta.description}}
> {{meta.description}}
{{/if}}

| Property | Value |
|----------|-------|
| Date | {{meta.date}} |
| Author | {{meta.author}} |
| Status | {{meta.status}} |
| Version | {{meta.version}} |
| Metamodel | Backstage Catalog |

---

## 1. Domain Overview

Domains and their constituent systems and components.

### Domain Hierarchy

{{#each domainOverview}}
| Domain | System | Component | Description |
|--------|--------|-----------|-------------|
| {{this.domainLabel}} | {{this.systemLabel}} | {{this.componentLabel}} | {{this.description}} |
{{/each}}

---

## 2. System Dependencies

System-level dependencies including APIs and resources.

### Dependency Map

| System | Depends On | Dependency Type |
|--------|------------|-----------------|
{{#each systemDependencies}}
| {{this.systemLabel}} | {{this.dependsOnLabel}} | {{this.dependencyType}} |
{{/each}}

---

## 3. API Landscape

API provision and consumption across the system boundary.

### APIs

| API | Description | Provider | Consumer |
|-----|-------------|----------|----------|
{{#each apiLandscape}}
| {{this.apiLabel}} | {{this.description}} | {{this.providerLabel}} | {{this.consumerLabel}} |
{{/each}}
Source: linked-archi-meta • Linked.Archi