Finding your way in the Simpl documentation

Last modified: 2026-11-16 23:19by Erik Hagen ID: 65e24b6e-d64e-4922-8147-1593f887bc02 SAMT-X/content-insight

The architecture and user documentation for Simpl now lives as Markdown files in GitLab, without a separate publishing site. This page is a guide to where to find what.


How the documentation is organised

The Simpl programme moved its documentation from Confluence to Git in autumn 2026. GitLab is now used as a kind of wiki: the README files act as entry portals with a “You are here” path at the top and links further down.

The structure follows the capability map. Under simpl-open there is one group for each dimension: administration, data, integration, infrastructure, governance and security. In addition there is cross-cutting, with the installation guide and user manual among other things, and foundations, with business processes, non-functional requirements and architecture. The old structure under “development” is being phased out, but during the transition, content may be found in both places.


Entry portals

PortalContent
Simpl-OpenThe start page: how the repositories fit together, getting started
FoundationsBusiness processes (BP01 onwards), non-functional requirements, architecture
ArchitectureTable of contents for all architecture documentation
Installation guideInstallation, versioned per release
User manualConfiguration and operation

The most important architecture files

FileWhat you will find
description.mdGeneral introduction to Simpl and the actors
capability-map.mdThe capability map: dimensions, capabilities and services
architecture-principles.mdThe ten architecture principles
architectural-patterns.mdRecurring architectural patterns
agent-anatomy.mdTier I and Tier II participants, and how a Simpl service is structured
connector.mdThe Dataspace Protocol and the connector
identification-authentication-and-authorisation.mdIdentity, authentication and authorisation
functional-architecture.mdThe services in each agent and how they interact
interface-catalogue.mdOverview of APIs
technology-choices.mdChosen open-source technologies
adr/Architecture decisions (ADRs)
controlled_vocabulary/Controlled vocabulary and glossary

The main document D1.3.4

The consolidated architecture specification, D1.3.4 Functional and Technical Architecture Specifications, still exists as one large Markdown file of around 18,800 lines. It was last changed in July 2026 and calls itself version 0.1. The smaller files and the ADRs are updated regularly and are therefore often more recent than the main document. This applies in particular to technology choices, interfaces and decisions.


Tips

  • The architecture model is in ArchiMate format (Archi with coArchi) in the “model” folder of the architecture repository. It can be opened in Archi.
  • To read everything together, the easiest is to clone the architecture repository and open it in a Markdown reader or editor.
  • The old architecture repository (simpl/simpl-open/architecture) is archived. The latest version there is from September 2025.