Schema: robos:ArchitectureDecisionRecord

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:ArchitectureDecisionRecord in the documentation package store.

Table of contents

  1. Specification Metadata
  2. Upstream Schema Basis (Refers From) & Global Standards Provenance
  3. Entity Relationship & Schema Context
  4. Property Constraints & SHACL Rules
  5. Canonical OSLC JSON-LD Example
  6. Programmatic SHACL Validation

Specification Metadata


Upstream Schema Basis (Refers From) & Global Standards Provenance

This RobOS schema is modeled after and directly aligns with two levels of global standards:

  • Universal Schema.org Class: https://schema.org/TechArticle (100% interoperability with search engines, web indexers, and general AI reasoning)
  • Specialized Domain Standard: https://adr.github.io/ (de facto standard for domain-specific ALM, BDD, or infrastructure operations)
  • Canonical Reference: https://schema.org/TechArticle
  • Agent Guidelines: When autonomous agents generate, expand, or validate instances of robos:ArchitectureDecisionRecord, they MUST adhere to and base their output on this referred schema object and universal Schema.org parent class, extending it with RobOS SDLC properties.

Entity Relationship & Schema Context

Architecture Decision Record robos:ArchitectureDecisionRecord

Governed by W3C SHACL shape urn:robos:shape:ArchitectureDecisionRecordShape within the Documentation & Diagrams (robos.docs) (robos.docs) package store.

dcterms:title robos:status robos:context robos:decision

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Architecture Decision Record must have a title.
robos:status Lifecycle Status 1..* xsd:string Architecture Decision Record must declare status (proposed, accepted, superseded, etc.).
robos:context Decision Context 1..* xsd:string Architecture Decision Record must provide architectural context and problem statement.
robos:decision Architectural Decision 1..* xsd:string Architecture Decision Record must state the architectural decision.

Canonical OSLC JSON-LD Example

{
  "@id": "urn:robos:adr:001-modular-kgraph",
  "@type": [
    "oslc_am:Resource",
    "robos:ArchitectureDecisionRecord",
    "robos:ADR",
    "schema:TechArticle"
  ],
  "dcterms:title": "ADR-001: Modular Namespaced Knowledge Graph Architecture",
  "robos:adrNumber": "ADR-001",
  "robos:status": "accepted",
  "robos:context": "Monolithic JSON-LD knowledge graph files cause merge conflicts in multi-repo and multi-team environments.",
  "robos:decision": "Adopt modular, namespaced package stores (.robos/kgraphs/<pkg>/package.jsonld) with git-tag versioning and aggregated backward compatibility.",
  "robos:consequences": "Eliminates team collisions, isolates domains, and allows fine-grained GitOps diffing.",
  "robos:date": "2026-03-15",
  "robos:hasFlowDiagram": "urn:robos:diagram:order-lifecycle-flow",
  "robos:package": "documentation",
  "robos:namespace": "robos.docs",
  "robos:schemaOrgType": "https://schema.org/TechArticle",
  "robos:domainStandard": "https://adr.github.io/"
}

Programmatic SHACL Validation

const { SHACLValidator } = require('/usr/local/share/robos/robos-graph/lib/shacl-validator');
const { OSLCGraphParser, OSLC_CONTEXT } = require('/usr/local/share/robos/robos-graph/lib/oslc-parser');

const validator = new SHACLValidator();
const result = validator.validateGraph(new OSLCGraphParser({
  "@context": OSLC_CONTEXT,
  "robos:nodes": [
    {
        "@id": "urn:robos:adr:001-modular-kgraph",
        "@type": [
            "oslc_am:Resource",
            "robos:ArchitectureDecisionRecord",
            "robos:ADR",
            "schema:TechArticle"
        ],
        "dcterms:title": "ADR-001: Modular Namespaced Knowledge Graph Architecture",
        "robos:adrNumber": "ADR-001",
        "robos:status": "accepted",
        "robos:context": "Monolithic JSON-LD knowledge graph files cause merge conflicts in multi-repo and multi-team environments.",
        "robos:decision": "Adopt modular, namespaced package stores (.robos/kgraphs/<pkg>/package.jsonld) with git-tag versioning and aggregated backward compatibility.",
        "robos:consequences": "Eliminates team collisions, isolates domains, and allows fine-grained GitOps diffing.",
        "robos:date": "2026-03-15",
        "robos:hasFlowDiagram": "urn:robos:diagram:order-lifecycle-flow",
        "robos:package": "documentation",
        "robos:namespace": "robos.docs",
        "robos:schemaOrgType": "https://schema.org/TechArticle",
        "robos:domainStandard": "https://adr.github.io/"
    }
  ],
}));

console.log("Conforms:", result.conforms); // Expected: true