Blog

Soft Skills of a Technical Writer

What soft skills should technical writers have when they start their career? Linguistic and technical understanding is important in our profession. So are the soft skills - just like in any other job. more ...

RDF is not XML – RDF serialization and iiRDS metadata

The world of technical writing loves XML. Its document type definitions are the foundation of structured authoring. XML and the underlying schemas structure the content of our information products. The benefits are twofold. Content is consistently structured and easy to read. Authors have an easier time writing the content. The structure provides guidelines for authoring. more ...

How to become a technical writer – Confessions of a former translator

A former translator, I worked the first seven years of my professional life in the translation industry, in various positions. While I learned a lot from this experience, it also left me, as a writer, frustrated. Translators are chained to their source text and writing the words of others in another language, usually focusing on what their clients want. more ...

tekom impressions part 2: API documentation and the VUKA world

Daniela Herbold and Ulrike Parson write about better API documentation and solutions for innovative human resources management. more ...

Impressions from tcworld 2017

Part 1: Improvisation, fluff hunt, and videos for technical documentation. 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

Add comment


  • facebook
  • linkedin
  • xing