Blog

tcworld 2018 part 1: Legal Requirements vs Readability

At this year's tcworld conference, there were a lot of discussions about standards and regulations for technical documentation. Experts such as Jens-Uwe Heuer-James and Torsten Gruchmann came together for a panel discussion where the following was repeatedly said: "We need an IEC 82079-1!" more ...

Working in self-organizing teams. Or: how we get rid of management

Today's world is VUCA : volatile, uncertain, complex, and ambiguous. Companies are facing complex challenges such as Industry 4.0 and the Internet of Things. Those who do not respond fast, may be driven out of the market. more ...

Office Pets. Part II: Blacky and Felix

This is the second (and last) part of our blog series about office pets. This time, we present Blacky and Felix, two brothers. They are six years old, curious, and always hungry. more ...

Check if or check that? Or: Have you tried turning if off and on again?

How often do we read or write that we should check something? Example: "Check if the computer is connected to power." Clear message, no misunderstanding. But what if it says: "Check that the computer is connected to power." more ...

Ten questions for Ines Lasch, intern at parson

Ines Lasch just finished her vocational training as a technical writer and is doing an eight-week internship at parson. We asked her ten questions. more ...

Insights into iiRDS

The tekom working group "Information 4.0" develops a new delivery standard for technical documentation - iiRDS (intelligent information request and delivery standard). iiRDS defines a package format and standardized metadata, making content delivery vendor-independent.

At the 2017 tekom spring conference, Ulrike Parson and Mark Schubert will present iiRDS with concrete examples.

1 Objectives of iiRDS

iiRDS defines metadata and a delivery format for intelligent information. Intelligent information is modular and format-neutral and adapts dynamically to application context. It can be queried and be displayed on various devices.

To create intelligent information, we need metadata so that we can get targeted access to individual information modules. Because most metadata is company-specific, iiRDS focuses on metadata about the information itself and provides docking points only for product-specific and variant-defining metadata that are usually defined by companies. The standardized package format of iiRDS enables delivery of intelligent information to a server or application.

2 Components of iiRDS

2.1 Metadata Definition

iiRDS defines metadata in the modeling language RDF Schema. The iiRDS schema describes relevant resources for technical documentation and their relations . Thus, the iiRDS schema can be considered a simple ontology.

These are the basic resources of the iiRDS schema:

  • Central resource is the InformationUnit: a package, a document, a topic, or a fragment within a topic.
  • Documents and topics have types. Example: Operating instructions and task.
  • Each InformationUnit has additional functional metadata and product metadata. Examples: required tools, maintenance intervals, events, product variants and features.

Auszug iiRDSExcerpt from the iiRDS schema. Graphic: Achim Steinacker, i-views gmbh
2.2 Package Format

An iiRDS package is a container with a given directory structure. The container contains files of the information product, as well as an RDF file with the metadata about the information product.

3 iiRDS Applied

During our presentation, we’ll explain details of the standard and also show an example about how to mark contents with iiRDS metadata. This way, you will get insights into the iiRDS ontology. We’ll put this theoretical standard into practice by marking XML content with iiRDS metadata. You will see how metadata makes the content more accessible to the user.

Find all information on the presentation at the tekom spring meeting here.

Ulrike Parson, CEO of parson AG, is a member of the Information 4.0 tekom working group and speaker of the modelling subgroup.
Mark Schubert, Technical Consultant at parson AG, is a specialist in XML-based documentation and knowledge modeling. He is a member of the iiRDS modeling subgroup.

Tags: iiRDS
  • linkedin
  • xing