Glossary · Packages and variants

iiRDS/H

Also known as: iiRDS/H package, handover variant, handover documentation

In iiRDS (intelligent information Request and Delivery Standard), iiRDS/H is a restricted iiRDS variant for the legally compliant handover of documentation for a specific product. It restricts content formats and mandates metadata: every document needs a PDF/A rendition, metadata must also be provided in JSON-LD, and iirds:formatRestriction is set to H.

iiRDS term
Ontology
Information architecture

In one sentence

iiRDS/H is the handover variant of iiRDS: PDF/A documents with mandatory metadata in JSON-LD, identified for a specific product and manufacturer.

Example

A machine builder hands over the documentation of machine serial number 123456 to the operator as one iiRDS/H package, with a content list in index.html and every document as PDF/A.

How it applies

Content: Only Documents and Packages are allowed as information units. Each Document needs at least one PDF/A-2 or PDF/A-3 rendition; other formats, such as spreadsheets or CAD files, may be added alongside. Selectors and nested ZIP archives are not allowed — supplier documentation is related through component trees instead.
Mandatory metadata: Each package names its creator; each document has a title, language, document type, document category (from the Handover Documentation Domain), author, and a product variant identified by product type and by serial number or instance URI, with the manufacturer named. Metadata must be provided in JSON-LD 1.1.
Content list: The root folder contains index.html, a human-readable table of all documents (the "main document" in VDI 2770), which is not itself referenced in the metadata.
Compliance and AI: Because identity, authorship and product are mandatory, a receiving system can file every document to the right asset automatically — and an AI assistant can answer for exactly the machine that was delivered.

iiRDS/H vs. unrestricted iiRDS

Unrestricted iiRDS supports fine-grained topics, fragments and selectors for intelligent delivery. iiRDS/H trades that flexibility for predictability: whole documents, fixed formats and a guaranteed set of metadata.

In RDF

Shown in Turtle for readability.

@prefix iirds: <http://iirds.tekom.de/iirds#> .

<urn:uuid:5b7e2f4a-9c1d-4e8b-a3f6-2d1c0b9e8a77> a iirds:Package ;
    iirds:iiRDSVersion "1.3" ;
    iirds:formatRestriction "H" .