Schema: robos:DocumentationPage

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:DocumentationPage 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://schema.org/TechArticle (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:DocumentationPage, 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

Documentation Page robos:DocumentationPage

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

dcterms:title robos:slug robos:docPath

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Documentation Page must have a title.
robos:slug URL / Document Slug 1..* xsd:string Documentation Page must declare a URL slug.
robos:docPath Document File Path 1..* xsd:string Documentation Page must specify a relative markdown document path.

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:doc:sdlc-architecture-guide",
  "@type": [
    "oslc_am:Resource",
    "robos:DocumentationPage",
    "robos:DocArticle",
    "schema:TechArticle"
  ],
  "dcterms:title": "RobOS Living SDLC Architecture & Graph Guide",
  "robos:slug": "sdlc-architecture-guide",
  "dcterms:description": "Comprehensive reference on the dual-state knowledge graph, modular packages, and living doc synchronization.",
  "robos:docPath": "docs/knowledge-graph.md",
  "robos:category": "Architecture",
  "robos:hasFlowDiagram": "urn:robos:diagram:order-lifecycle-flow",
  "robos:package": "documentation",
  "robos:namespace": "robos.docs",
  "robos:schemaOrgType": "https://schema.org/TechArticle",
  "robos:domainStandard": "https://schema.org/TechArticle"
}

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:doc:sdlc-architecture-guide",
        "@type": [
            "oslc_am:Resource",
            "robos:DocumentationPage",
            "robos:DocArticle",
            "schema:TechArticle"
        ],
        "dcterms:title": "RobOS Living SDLC Architecture & Graph Guide",
        "robos:slug": "sdlc-architecture-guide",
        "dcterms:description": "Comprehensive reference on the dual-state knowledge graph, modular packages, and living doc synchronization.",
        "robos:docPath": "docs/knowledge-graph.md",
        "robos:category": "Architecture",
        "robos:hasFlowDiagram": "urn:robos:diagram:order-lifecycle-flow",
        "robos:package": "documentation",
        "robos:namespace": "robos.docs",
        "robos:schemaOrgType": "https://schema.org/TechArticle",
        "robos:domainStandard": "https://schema.org/TechArticle"
    }
  ],
}));

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