robos:Documentation

Validation shape for robos:Documentation nodes in the documentation package group.

Details

Class	robos:Documentation
Also matches	robos:SystemDocumentation
Shape id	urn:robos:shape:DocumentationShape
Package	Documentation & Diagrams (robos.docs) (documentation)
Classification	Documentation & decisions
Schema.org type	schema:TechArticle

Properties

Count is the minimum and maximum number of values (* means no maximum). The validator enforces both. The type column is documentation only; the validator does not check types.

Property	Count	Type	Rule or description
dcterms:title	1..*	xsd:string	Documentation must have a title.
robos:targetEntity	1..*	-	Documentation must specify the documented target entity identifier or URI.
robos:docPath	1..*	xsd:string	Documentation must specify its markdown artifact path.
robos:gitopsFile	1..*	xsd:string	Documentation must declare its GitOps file location (.robos/documentation.yaml).

Example node

This node comes from .robos/kgraphs/documentation/package.jsonld in the RobOS repository. That graph holds sample data for a fictional company, so treat the values as illustrations.

{
  "@id": "urn:robos:documentation:billing-api",
  "@type": [
    "oslc_am:Resource",
    "robos:Documentation",
    "schema:TechArticle"
  ],
  "dcterms:title": "Billing API Microservice Architecture",
  "dcterms:description": "Living architectural documentation and component topology for Billing API Service.",
  "robos:targetEntity": "urn:robos:service:billing-api",
  "robos:docPath": "docs/architecture/billing-api.md",
  "robos:gitopsFile": ".robos/documentation.yaml",
  "robos:category": "Services",
  "robos:lastUpdated": "2026-09-25T12:00:00.000Z",
  "robos:package": "documentation",
  "robos:namespace": "robos.docs",
  "robos:schemaOrgType": "https://schema.org/TechArticle",
  "robos:domainStandard": "https://schema.org/TechArticle"
}

Validate the example

Save the example as node.json in the repository root, then run:

node -e "const { SHACLValidator } = require('./packages/robos-graph/lib/shacl-validator'); console.log(new SHACLValidator().validate([require('./node.json')]).conforms)"

The command prints true when the node meets every rule for its types.